Skip to content

An example showing how to use the CTO.ai CircleCI Orb to use the Events API. This enables Workflow Metrics.

Notifications You must be signed in to change notification settings

cto-ai/events-orb-example

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 

Repository files navigation

CircleCI Orb for CTO.ai Workflow Metrics

If your CICD runs on CircleCI, you can use the CTO.ai CircleCI Orb to make it easier to instrument your CICD with workflow events. The Orb can be accessed with this stanza in your CircleCI configuration yaml:

orbs:
  cto-ai: cto-ai/[email protected]

Use the Orb to send events to CTO.ai by calling it from your steps:

      steps:
        - cto-ai/event:
            token: ${CTOAI_EVENTS_API_TOKEN}
            team_id: ${CTOAI_TEAM_ID}
            event_name: deployment
            event_action: success
            branch: ticket-id-1234
            commit: pipeline-label-A1
            image: branch-label-543

Note: only token and team_id are required fields. The other fields are optional.

CTOAI_EVENTS_API_TOKEN is a secret environment variable provided by CTO.ai that you set in your CircleCI config, and then pass to the Orb. If you don't have a token, instructions on how to get one are available here: https://cto.ai/docs/integrate-any-tool.

You can set your environment variables in a CircleCI Context, in your Organization Settings, or on your Project Settings. The environment variable must then be accessed from the user's CircleCI config (e.g. CTOAI_EVENTS_API_TOKEN as seen above) and passed to the Orb to use the CTO.ai Events API.

The team_id is also a required field, and could also be accessed using an environment variable as shown in the example above. Since the team_id is not a secret, however, this is not strictly necessary. It could be supplied directly in your config file. Instruction on how to get one are available here: https://cto.ai/docs/integrate-any-tool#acquire-team-uuid

More information on CTO.ai Insight Events Metrics: https://cto.ai/docs/insights-events

About

An example showing how to use the CTO.ai CircleCI Orb to use the Events API. This enables Workflow Metrics.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published