Skip to content

Nightly opentelemetry.io audit #14336

@jaydeluca

Description

@jaydeluca

Context

The documentation site has a table listing instrumentation modules and their associated "name" that can be used to disable them. This list is maintained manually, and often is not kept up to date.

image

Solution

We can use the instrumentation-list.yaml in order to cross reference and audit the table in the documentation site so that we can be notified/reminded when we need to update the doc site.

Requirements

  • Pull and parse the current list of instrumentations from the disable list markdown source on the opentelemetry.io site
  • Pull the latest instrumentation-list.yaml
  • Identify deltas in the instrumentation lists, and if they exist, open an issue in the instrumentation repo to update them

The first step is to test the nightly run:
#14312

After that is tested/validated the next step will be to:

  • Extend the checking functionality to analyze them in both directions. If we remove an instrumentation from the repo, we should be notified to also remove it from the opentelemetry.io site
  • Incorporate the automation to open an issue for discrepancies instead of just failing the github action task

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Status

In review

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions