​

Intro

• Access Observability Metrics
• Required grants
• Add a Domo access token account
  • Generate an access token
• Create a job
• Schedule a job
• Run a job
• Clone a job

​

Access Observability Metrics

1. In the navigation header, go to More > Admin. The Admin Settings display.
2. In the Governance menu, select Toolkit. The Toolkit opens.
3. Under either Your Tools or Available Tools, select Observability Metrics.
   
   Note: If the Toolkit option does not display in the Governance menu, ensure your user role has the required grants. You may need to enable the Toolkit by reaching out to your account team.

​

Required Grants

1. Create Custom Pipeline Processes — Allows you to create, update, share, and delete jobs. Only allows you to view jobs that they created or jobs that have been shared with them.
2. Administer Custom Pipeline Processes — Allows you to create, update, share, and delete jobs. Also allows you to see all jobs within the pipeline.

• Export from Domo — Allows you to export data, Cards, or reports from Domo to external formats or destinations.
• Manage all access tokens and API clients — Allows you to create, view, and manage all access tokens and API clients used to connect external tools or services to Domo.
• Manage all Cards, Pages, Apps (App Studio), and Reports (Report Builder) — Allows you to create, edit, move, and delete any Card, Page, App, or Report in Domo, regardless of ownership.
• Manage DataSet — Allows you to create, edit, replace, and delete any DataSet in Domo, including its schema and data connections.
• View activity logs — Allows you to access and review detailed logs of user and system activity within your Domo instance.
• View usage metrics — Allows you to view instance-level usage data, including activity and resource metrics across Domo.

​

Add a Domo Access Token Account

1. In the navigation header, go to Data.
2. From the left side rail, select Accounts.
3. Select + Add New > Account to open the Add Account modal.
4. In the modal, search for and select Domo Access Token. Two options display for creating an account. Only one option is required.
   1. With an access token. To generate an access token, follow the steps in the section below (see Generating Access Tokens). Then, return to this task and paste the token into the Option 1: Remote Instance Access Token field in the Add Account modal.
      
   2. With a username and password. This is the same username and password used in the target Domo instance.
5. Select Connect.

​

Generate an Access Token

1. In the navigation header on your target instance, go to More > Admin.
2. Under Authentication, select Access tokens.
3. Select + Generate access token and search for the Domo user requesting the access token. Choose an expiration date and select Generate. An access token displays.
4. Copy the access token. The token is no longer available when you navigate away from the page.

​

Create a Job

1. Access Observability Metrics .
2. Select + New Job.
3. In the Job Details, fill out the following information:
   • (Required) Job name
   • (Optional) Job description
4. In the Configuration section of the Job Details tab, specify the following:
   • Select the account for your instance (this account must be created prior to creating a job).
   • Enter the URL of the instance (domain. domo.com ). Remember to include ” domo.com” at the end of your URL.
   • Select an option for where you’d like to save run logs:
     1. New DataSet
        • Creates a new DataSet in your Domo instance. All runs of the job will write logging to the new DataSet.
     2. Existing DataSet
        • Existing DataSet allows you to combine multiple Domo Observability Metric jobs into a single logging DataSet.
        • Must be a DataSet created by the Domo Observability Metrics tool.
        • The existing DataSet must already contain rows of data.
5. In the Report and DataSet Mapping section of the Job Details tab, specify the following:
   • Select a report type from the menu.
   • Adjust toggle to either New DataSet or Existing Dataset
     • If you choose New DataSet, enter a name in the New DataSet Name field.
     • If you choose Existing Dataset, select a DataSet from the menu.
     Important:

     • Using an existing DataSet will overwrite the data that exists on that DataSet.
     • Each report should have a different DataSet. Different report types cannot use the same DataSet.
6. Select Submit. The new job now appears in the job list on the main Observability Metrics page.
7. (Optional) To add multiple reports, select + Add Another Report. Repeat the previous steps.

​

Schedule a Job

1. Access Observability Metrics .
2. In the Scheduling tab, complete the following:
   • Select the frequency the job should run.
   Note: Some inputs are disabled depending on the chosen reports. Reports for “People” and “Group Membership” are the only reports that can be triggered more frequently than daily. They must be in a job with no other reports to run more frequently.
   • Switch the toggle to Active.

​

Run a Job

You can manually run a job by selecting Job Options > Run Job.

1. Select Edit in the job’s details.
2. Select the current DataSet. A search menu displays containing all available DataSets in your instance.
3. Search for the replacement DataSet. Select Choose DataSet.

​

Clone a Job

1. Access Observability Metrics . A list of jobs in your instance displays.
2. Hover over a job in the list. Select Job Options > Clone. The Clone Job modal displays.
3. Enter a name, optional description, instance URL, and select the instance’s Access Token account.

4. Select Clone Job. The cloned job appears in the job list on the main Observability Metrics page.