Add tags to remaining OTel content package dashboards#19942
Conversation
Add a kibana/tags.yml to the remaining OTel content packages (web servers/proxies, message queues, containers/orchestration, infra/system, monitoring/caching, and others) so their dashboards are tagged with the technology and OpenTelemetry, plus a Kubernetes tag where relevant. This makes the assets filterable and identifiable in Kibana for SAs and customers. Content packages tag assets via kibana/tags.yml (text + asset_types), mirroring the existing kubernetes_otel package; the kibana/tag/*.json saved-object form is only valid for integration packages. Relates elastic/obs-integration-team#1136
fc96da8 to
f6ac740
Compare
✅ Elastic Docs Style Checker (Vale)No issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
Add `alerting_rule_template` to the asset_types in kibana/tags.yml for packages that ship alert rule templates, so those assets get the same tags as the dashboards. Relates elastic/obs-integration-team#1136
|
✅ All changelog entries have the correct PR link. |
|
@elastic/obs-ds-hosted-services please review the PR |
💚 Build Succeeded
History
|
|
Tick the box to add this pull request to the merge queue (same as
|
|
Package activemq_otel - 0.3.0 containing this change is available at https://epr.elastic.co/package/activemq_otel/0.3.0/ |
|
Package airflow_otel - 0.3.0 containing this change is available at https://epr.elastic.co/package/airflow_otel/0.3.0/ |
|
Package apache_otel - 0.6.0 containing this change is available at https://epr.elastic.co/package/apache_otel/0.6.0/ |
|
Package apache_tomcat_otel - 0.3.0 containing this change is available at https://epr.elastic.co/package/apache_tomcat_otel/0.3.0/ |
|
Package docker_otel - 0.3.0 containing this change is available at https://epr.elastic.co/package/docker_otel/0.3.0/ |
|
Package envoyproxy_otel - 0.4.0 containing this change is available at https://epr.elastic.co/package/envoyproxy_otel/0.4.0/ |
|
Package haproxy_otel - 0.3.0 containing this change is available at https://epr.elastic.co/package/haproxy_otel/0.3.0/ |
|
Package ibmmq_otel - 0.3.0 containing this change is available at https://epr.elastic.co/package/ibmmq_otel/0.3.0/ |
|
Package iis_otel - 0.5.0 containing this change is available at https://epr.elastic.co/package/iis_otel/0.5.0/ |
|
Package kafka_otel - 0.3.0 containing this change is available at https://epr.elastic.co/package/kafka_otel/0.3.0/ |
|
Package kubernetes_otel - 2.4.0 containing this change is available at https://epr.elastic.co/package/kubernetes_otel/2.4.0/ |
|
Package memcached_otel - 0.3.0 containing this change is available at https://epr.elastic.co/package/memcached_otel/0.3.0/ |
|
Package nginx_ingress_controller_otel - 0.4.0 containing this change is available at https://epr.elastic.co/package/nginx_ingress_controller_otel/0.4.0/ |
|
Package nginx_otel - 0.6.0 containing this change is available at https://epr.elastic.co/package/nginx_otel/0.6.0/ |
|
Package nvidia_gpu_otel - 0.3.0 containing this change is available at https://epr.elastic.co/package/nvidia_gpu_otel/0.3.0/ |
|
Package profilingmetrics_otel - 0.1.0 containing this change is available at https://epr.elastic.co/package/profilingmetrics_otel/0.1.0/ |
|
Package rabbitmq_otel - 0.3.0 containing this change is available at https://epr.elastic.co/package/rabbitmq_otel/0.3.0/ |
|
Package system_otel - 0.3.0 containing this change is available at https://epr.elastic.co/package/system_otel/0.3.0/ |
|
Package traefik_otel - 0.3.0 containing this change is available at https://epr.elastic.co/package/traefik_otel/0.3.0/ |
|
Package vsphere_otel - 0.3.0 containing this change is available at https://epr.elastic.co/package/vsphere_otel/0.3.0/ |
|
Package zookeeper_otel - 0.3.0 containing this change is available at https://epr.elastic.co/package/zookeeper_otel/0.3.0/ |
Proposed commit message
Add a
kibana/tags.ymlto the remaining OpenTelemetry content packages (web servers/proxies, message queues, containers/orchestration, infra/system, monitoring/caching, and others) so their dashboards are tagged with the technology andOpenTelemetry, plus aKubernetestag where relevant. This makes the assets easy to filter and identify in Kibana for SAs and customers.Content packages tag their assets via
kibana/tags.yml(text+asset_types: [dashboard]), mirroring the existingkubernetes_otelpackage. Note: thekibana/tag/*.jsonsaved-object + dashboard-referencesform referenced in the issue is only valid for integration packages; the content-package spec (additionalContents: false) does not allow akibana/tag/folder, sotags.ymlis used instead. As a consequence tag colors are not settable (Kibana auto-assigns them) and dashboards are not modified.kubernetes_otelalready had anOpenTelemetrytag; this PR adds the missingKubernetestag to it.Packages in this PR (21):
apache_otel,apache_tomcat_otel,envoyproxy_otel,haproxy_otel,iis_otel,nginx_otel,nginx_ingress_controller_otel,traefik_otel,activemq_otel,ibmmq_otel,kafka_otel,rabbitmq_otel,docker_otel,kubernetes_otel,nvidia_gpu_otel,system_otel,vsphere_otel,memcached_otel,zookeeper_otel,airflow_otel,profilingmetrics_otel.Checklist
changelog.ymlfile.Author's Checklist
kibana/tags.ymland applied todashboardassets on install.How to test this PR locally
elastic-package buildin each changed package.cd packages/kubernetes_otel && elastic-package install) against a running stack.OpenTelemetry(andKuberneteswhere applicable) tags are attached, and that the dashboards are discoverable by filtering on those tags.Related issues
Screenshots