elastic/kibana

[APM] Metrics: Dashboard names should be snake_case

Open

#222795 opened on Jun 5, 2025

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (19,065 stars) (8,021 forks)batch import
OpenTelemetryTeam:obs-ux-infra_services - DEPRECATEDapmapm:opentelemetryapm:service-metricsbuggood first issue

Description

Kibana version: >= 8.18 and 8.17

When introducing the new dashboard names pattern, we didn't pay attention that they should match the snake_case file names pattern in Kibana ( We missed that because of this, which is ignoring the files also under the dashboards folder). This was found while backporting to 8.17 where the ignore list was not yet extended.

The goal of this issue is to change the pattern from ${dataFormat}-${sdkName}-${sdkLanguage} to ${dataFormat}_${sdkName}_${sdkLanguage} where all 3 (dataFormat, sdkName, sdkLanguage) are converted to kebab-case or camelCase to avoid breaking the separation - let's check examples:

  • otel_native-edot-java should become otel-native_edot_java OR
  • otel_native-otel_other-go > otelNative_otelOther_go As long as it's readable and the separation is clear, it doesn't really matter which pattern is followed

AC:

  • Follow the correct pattern in the names as described in the issue
  • Remove those changes in 8.17 (backport this solution)
  • The build (quick checks as well, after removing this) should pass
  • Same on the newer versions (the quick checks should pass when removing this)
    • ⚠ Do not remove this yet when merging, as it might break other things, but can be removed just to test the dashboard names and return them.

Contributor guide

Tech stack
typescriptjavascriptnodejs
Domain
developer experiencebuild system
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
JavaScript/TypeScriptKibana file structureAPM dashboardsfile casing rules
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Start by examining the current dashboard naming pattern in the APM metrics folder. Look at the file casing check at src/dev/run check file casing.ts and the related PR #222527. Then rename all dashboard files to follow the new underscore pattern (e.g., otelNative edot java) and remove the ignore entries for the dashboards folder to ensure the build passes.