Tutorial about how to integration with users' deployment processes

[EYHN]

Perfsee can analyze performance of applications after every deployment and send rich performance reports to developers to keep them informed of performance changes in new releases.

Tracking Pull request performance

Deploy test environment for each Pull Request, and perfsee will automatically analyze performance for each pull request and show performance reports in the Pull Request comments.

Integration

Perfsee provides multiple ways to integrate with your existing deployment (pipeline/platform/workflow) with minimal changes.

• • Vercel
• • Netlify
• • Github Action github actions used to trigger lab scanning #80

  https://github.com/EYHN/perfsee-action-test

• • Github Deployment - for Github Pages or other custom process.

  Github Deployments are requests to deploy a specific ref (branch, SHA, tag). GitHub dispatches a deployment event that external services can listen for and act on when new deployments are created. Github Deployments enable developers and organizations to build loosely coupled tooling around deployments, without having to worry about the implementation details of delivering different types of applications.

  Perfsee can be used with Github Deployments by creating a simple github action workflow.

  Create access token

  Follow the tutorial here create an access token.

  In your Github repository, go to Settings > Secrets > Action to save the Access Token you just created as PERFSEE_TOKEN for action use.

  Create same environments on Perfsee and Github

  You need to make sure you have created environments on perfsee with the same name as github, for Github Page usually be github-pages. To check environments, open Settings > Environments in Github repository and Settings > Environments in Perfsee project.

  

  Create github action workflow

  Create a new action workflow .github/workflows/after-deploy.yaml in your repository.

  name: After deploy
  
  on: [deployment_status]
  
  jobs:
    lab:
      # only runs this job on successful deploy
      if: github.event.deployment_status.state == 'success'
      runs-on: ubuntu-latest
      steps:
        - name: Run lab
          uses: EYHN/[email protected]
          with:
            project: perfsee
            token: ${{ secrets.PERFSEE_TOKEN }}

  Trigger a deployment

  Create a deployment or deploy a github page, you can see the status of the deployment in your pull request or https://github.com/xxx/xxx/deployments, and when the deployment is done you can see the github action running successfully and the perfsee lab test in your commit.

  Deployment stats:

  

  Github action and perfsee lab:

  
• • Command Line Tool

  After deployment, you can use command line tool to start a lab scan from your automatic deployment script or the terminal. Be aware that the lab scan requires access to your application, make sure the application is ready to use.

  Create access token

  Follow the tutorial here create an access token and save it for later use.

  Installation

  Use the following command to install command-line tools via npm.

  Detail documentation for @perfsee/sdk

  npm install -g @perfsee/sdk

  Trigger a lab scan

  After your application has been deployed, run the following command to start a lab scan.

  In the command you need to provide the access token which you created earlier and the project id, and the git commit hash of this deployment to match the lab snapshot to the commit.

  perfsee take-snapshot --token <access-token> --project <projectId> --hash <commit-hash>

  If success it will log out Created snapshot #1 and you can view the results on the platform.

• • HTTP Api feat(platform-server): take snapshot restful api #149