This guide will walk you through how you can automatically populate your software catalog using OpsLevel's integrations, however there are many ways to populate and maintain your catalog in OpsLevel:
- Detecting services via integrations as outlined in this guide
- Using our kubernetes syncing tool
- Using a config-as-code approach via opslevel.yml files stored in your repo
- Directly using our Terraform provider, GraphQL API or CLI tool
When you add a new Git or Alert Source integration, OpsLevel can automatically recommend services based on the Git repositories, Datadog monitors and services from Pagerduty and OpsGenie that are synced into OpsLevel.
When new services are detected, the Service Show page will include a badge on the Detected Services button.
You can also go directly to the page from the Catalog > Detected Services item in the navigation menu. Once on the Detected Services page, you will see a list of Pending Services that OpsLevel has detected from your repositories and alert sources. From this list, you will be able to see the Service alias identified during the detection process, where the Service was detected from, and when the Service was detected. When more than one repository or alert source suggestion identify a service with the same service alias, they will be merged into a single suggestion. You can use the
+ expand button to see each of the repositories and alert sources that support this Detected Service.
If you see a Recommended Service or Services that you want to add to your Service Catalog, you can add it by selecting the Service(s) and clicking
Accept from either the Actions column or the Bulk Actions dropdown. If the recommended service was detected by more than one repository or alert source, you will be prompted to choose if you would like to ignore any of the linked repositories or alert sources from your new service.
If you see a Recommended Service or Services that you do not want added to your Service Catalog, you can ignore them by selecting the Service(s) and clicking
Ignore from either the Actions column or the Bulk Actions dropdown.
Any action that you take is recorded to help you audit any events created from suggestions in the Recent Activities tab.
If you've accidentally ignored a Recommended Service, you can add them back to the Pending Services list. Selecting Ignored from the Status dropdown will display all of the Recommended Services that have been set to Ignore. You can add these Services back to the Pending Services list selecting the Service(s) and clicking
Unignore from either the Actions column or the Bulk Actions dropdown.
Service Detection is enabled by default for Datadog and Git Integrations, but it can be disabled from the integration's setup page. In the Integration page, there is a Disable service detection button within the Service Detection card. Clicking this button will pause service recommendations for that integration as well as remove existing recommendations from the Service Detection page. If at a later time you want to resume receiving Service Recommendations, you can do so by clicking the Enable service detection button. Re-enabling Service Detection will also bring back any recommendations that were removed when disabling.
In order to allow you to tailor Service Detection for your own unique data and needs, you are able to create a list of regular expressions that OpsLevel will use to automatically reject service suggestions. Each integration with Service Detection enabled has their own list of rules. To modify your list, navigate to the Integration page and scroll to the Service Detection card.
When a Service is detected from that integration, we identify a service alias for the resulting suggestion. If that service alias matches any of the ignore rules defined for that integration, then the Service suggestion will not be created. When a new rule is added, the rules will be applied to existing suggestions and any matches will be removed.
To add new ignore rules:
- Press the + Add Rule button
- Enter a value
- Repeat steps 1 and 2 for all desired rules
- Press the Save Rules button.
To remove an ignore rule:
- Press the Delete button next to the rule you wish to remove
- Press the Save Rules button.
Note: We use a case insensitive match for regular expressions.
If OpsLevel is sent a deploy or a check with a service identifier that we don’t recognize yet, we will suggest that you either add a new service or add it as an alias to an existing service.
You’ll find the suggestions on the Detected Services page, under the Aliases tab. We show a list of unique service identifiers that we’ve received from deploys or checks, but didn’t match directly to any known service. We also display the source of each service identifier in the Source column. We will suggest mapping the deploy or check result to an existing service if the name is similar, otherwise we will suggest adding a new service to OpsLevel.
Review the suggestions and make any changes to the action or service name. The actions are:
Create- Make a new service and attach the associated deploys and check results.
Map- Attach the alias to the existing service and merge the new deploys/check results with the old deploys/check results.
Once the action and service name are correct, hit
Accept to take the suggested action.
You can also hide the suggestions if they aren’t helpful by clicking
Ignore. You can view ignored suggestions by changing the filter from
Status: Pending to
Status: Ignored. You can then have them show again by clicking
Note: Ignoring suggestions will ignore them for the entire account.
Updated 6 months ago