Skip to content

Conversation

cn-service-catalog-bot[bot]
Copy link

Note: Please review and update any fields as needed.

This PR adds an AI-generated Service Catalog workflow to automatically register this service.

AI-Generated Metadata:

Please review these fields and update them if necessary:

  • Description (Required): "Ensures compliance with open source standards in JavaScript projects by running automated checks against code and community guidelines."
  • Team (Required): Opensource Check Team
  • Tier (Required): 4 (Low - Development tools, scripts, documentation, prototypes)
  • Contacts: Zack Tollman, Matt Bedell
  • service-group: opensource-check

Data that needs to be filled manually:

  • data-sensitivity (Required)
  • slack (Required)
  • links (Required)
  • pagerduty

What this does:

  • Adds a GitHub workflow that runs when changes are made to the service.yml file
  • Provides visibility into service ownership, documentation, and monitoring
  • To know more about what service catalog is, please refer to this page.

Field Guidance:

  • service-name: The name of your service. If your service is using Datadog’s APM product, you should match up the application names so that you get automatic trace correlation. If your application is deployed to global platform, this will be the helm_release_name
  • description: A useful description of your application
  • data-sensitivity: Provides information on whether the service handles (processes, stores, or transmits) PII information or not. As this is a mandatory security requirement, please specify the service tag as either:
    • PII
    • non-PII
  • service-group: An optional application name that your service contributes to e.g. a backend service and frontend service may roll up into a product name. The services are grouped based on this name, and is helpful when you have multiple services that work together as a part of a larger system.
  • tier:
    • Tier 1 (critical): Business critical. Powers core functionality with significant brand or reputation risk if down
    • Tier 2 (high): Customer facing, non-core functionality.
    • Tier 3 (medium): Internal workflow tools that block progress if down, but do not have a visible user impact
    • Tier 4 (low): Experimental or non production applications that have minimal impact
  • lifecycle: "production" for services that are live, "development" for services that are yet to launch
  • team: The name of the owning team. This should not be an individual person.
  • slack: If your team has a support channel, put that here. You can get a slack channel url by right clicking the channel name in the sidebar of your slack client.
  • languages: Specifies the programming language used in the service. For datadog service catalog valid values could include dotnet, go, java, js, php, python, ruby, or c++. This helps categorize your service by language for easier management.
  • links: Supporting links for your service. If the lifecycle of your application is production, you must include links to github repo, a runbook, metric dashboards, and logging dashboards. If there is relevant documentation, please add this too.
  • pagerduty: You can link to PagerDuty here so that people can directly page a team when seeing a failing service. To find your pagerduty url go to PagerDuty → Service Directory → Find your service → Copy the direct link to your service.
  • contacts: A list of individuals who can be contacted about the service.

The AI has analyzed the repository content, contributors, and characteristics to generate appropriate metadata.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants