Get started using Compass
What is a component?
Search the component catalog
Create, view, update, and delete components
Create components using the API
Import components from other apps
Import components from a CSV file
Import components from Bitbucket
Import components from GitHub
Import components from GitLab
Import components from repositories linked to Jira Software
Import services from Jira Service Management as components
Add or remove component details
Assign and update a component’s owner
Show on-call information from incident management tools on a component
Make and receive announcements
View a component's activity
What is an activity feed?
Get events from connected event sources
Send events using REST API
View a component's activity feed
Add or remove component dependencies
Link Jira issues to components
Link components to services in Jira Service Management
Create, view, edit, and delete custom fields
Create, connect, and view component metrics
What are metrics
Create, edit, and delete metrics
Connect, view, and disconnect component metrics
What are derived metrics
Push metrics values using a cURL command
Get metrics from integrated tools
Available predefined metrics
Pin metrics to the top of metrics lists
Watch a component
Configuration as code
What is config as code?
Structure and contents of the compass.yml file
Manage components with config as code
Update components managed with config as code
Disconnect managed components from config as code
Create a template
Use a template
What is a team in Compass?
Start or search for a team
View a team's dashboard
What is CheckOps?
Start CheckOps with your team
View past CheckOps information
What does health mean for you and your teams in Compass?
View your component's health details
What is a scorecard?
What is component readiness?
Create, view, update, and delete scorecards
Apply or remove scorecards
View and update a component's score
Use metrics with scorecards
What are metric thresholds?
How do scorecards use metrics?
Add a metric as a scorecard criterion
Use custom fields with scorecards
View scorecard health data
Integrate Compass with Bitbucket Cloud
Integrate Compass with CircleCI
Integrate Compass with GitHub
Integrate Compass with GitLab
Integrate Compass with New Relic
Integrate Compass with Opsgenie
Integrate Compass with PagerDuty
Integrate Compass with Slack
Integrate Compass with Statuspage
Integrate Compass with Swagger UI
Developer and API guides
Get started building Compass apps
Create a data provider app for events and metrics
GraphQL API toolkit
Use the API toolkit
API reference guide
API error guide
API requests examples
Rate this page:
Rate this page: