PipeRider
Search…
⌃K

Get Started

Start uploading reports to PipeRider Cloud

PipeRider Cloud features

With a PipeRider Cloud account you can upload reports from PipeRider CLI and access the following features:
  • Share reports online
  • Compare profiling reports online
  • View time-series data for certain metrics
  • Create monitoring alerts and forward alert notifications to email or Slack
Reports can be configured to automatically upload each time PipeRider is ran, or can be uploaded individually (see below).

How to access PipeRider Cloud

Prerequisites

In order to upload reports to PipeRider Cloud, you are first required to install PipeRider CLI.

Sign up

To sign up for PipeRider Cloud account please visit the Sign Up page and fill out the form.
A verification email will be send to your email address. Follow the link in the verification email to complete your account set up.

Log in

Reports are uploaded to PipeRider Cloud via PipeRider CLI. To enable report uploading you need to add your API Token to PipeRider CLI.

Obtain your API Token

An API token can be obtained from your PipeRider Cloud profile page.
Sign in, or Sign up, at PipeRider Cloud. Once logged in, click the account drop-down at the top right and then click Profile.
Select Profile from the user account drop-down
From your Profile, click the Copy button next to your token at the bottom to copy your API token to the clipboard.
PipeRider User Profile

Log into the PipeRider Cloud from the CLI

From the command line, use the following command to log into PipeRider Cloud.
piperider cloud login
Enter your email address and API token when prompted.
$ piperider cloud login
Please provide available email account to login
[?] Email address: [email protected]
Please paste the api token from magic link. The link has been sent to your email address.
[?] API token: abc123
If your log in was successful, you'll see your User Profile details:
[?] API token: abc123
───────────────────────────── Login Successful ─────────────────────────────
User Profile
Email Username Full Name Storage Location Timezone
───────────────────────────────────────────────────────────────────────────
[email protected] Support PipeRider North America Asia/Taipei
Select if you would like reports to be automatically uploaded to your PipeRider Cloud account.
Please select default behavior for auto upload
[?] Auto upload reports to cloud (Y/n): Y
[Config] Default auto upload behavior is set to True
Your API token and default upload settings are stored in your PipeRider profile ~/.piperider/profile.yml
~/.piperider/profile.yml
user_id: user123
...
api_token: abc123
cloud_config:
auto_upload: true
If auto_upload is enabled, PipeRider CLI will automatically upload every report during piperider run

Verify PipeRider Cloud connection

Verify your connection to PipeRider Cloud by running the diagnose command from inside a PipeRider project.
piperider diagnose
If correctly configured, you should see the following message in the output.
Check cloud account:
Run as user: [email protected]
User Name: Support
Full Name: PipeRider Support
Auto Upload: True
✅ PASS

Manually upload reports

Use the following command to manually select reports to upload.
piperider cloud upload-report
Use the arrow keys to navigate the list, and press space to select the reports you would like to upload.
$ piperider cloud upload-report
────────────────────────── Select Reports to Upload ───────────────────────────────
[?] Please select the reports to upload ( SPACE to select, and ENTER to confirm ):
o jaffle_shop #table=5 #pass=61 #fail=1 2022-12-14T09:37:14.342456Z
X jaffle_shop #table=5 #pass=60 #fail=1 2022-12-13T11:26:33.315632Z
X jaffle_shop #table=3 #pass=57 #fail=1 2022-12-08T17:04:06.084280Z
o jaffle_shop #table=5 #pass=80 #fail=1 2022-12-08T17:03:32.378543Z
Press the return key to upload the reports.
URLs for uploaded reports will be shown in the CLI output. You can also go directly to https://cloud.piperider.io to view all uploaded reports.

Cloud Overview

Landing Page
  1. 1.
    Data source name
  2. 2.
    Current Report context
  3. 3.
    Data / Assertions tab
  4. 4.
    Navigation bar
  5. 5.
    Report sharing button
  6. 6.
    Profile dropdown
  7. 7.
    Community channels
By default, the landing page shows the context of latest report.
Click the navigation bar, the pop-up will list the all of upload reports and comparison reports if any.
Click on a run to view the report.
Navigate Reports

Metric Monitoring

Once multiple profiling results are uploaded under the same data source. PipeRider Cloud will analyze and display the trending of a few metrics that it could help you monitor/capture if any considerable changes.
Metrics Trending
Select a metric or a timespan from drop-downs or drag/scroll on the area of the chart to zoom in/out.

Compare Reports

Select any two of reports for the comparison. Click Cancel to clear the selection.
Compare Reports

Share Report

Click Share to toggle the sharing and gain the sharable URL.

User Profile

View/Edit the profile and retrieve the token again.
User Profile

Delete your account

To delete your account, and all associated data and reports, click the Delete User Account button at the bottom of your User Profile page.
Click the Delete User Account button
You will be prompted to enter your account email to confirm you really want to delete the account. Click Delete User Account to initiate your account deletion.
Enter the email address associated with your account
You will be prompted to take the survey, click the Let's Go button to start the survey (it's only three questions).
Complete the survey to finalize your account deletion
Once the survey is complete your account will be deleted and you will receive and confirmation email.
Please note that your account and data is not deleted until the survey has been submitted