Skip to content

[mackerelotlpexporter] fix: rename the component and set alias to match naming convention#105

Merged
Arthur1 merged 1 commit intomainfrom
component-name-convention
Jan 28, 2026
Merged

[mackerelotlpexporter] fix: rename the component and set alias to match naming convention#105
Arthur1 merged 1 commit intomainfrom
component-name-convention

Conversation

@Arthur1
Copy link
Copy Markdown
Member

@Arthur1 Arthur1 commented Jan 27, 2026

https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/coding-guidelines.md#component-naming

Components (receivers, processors, exporters, extensions, and connectors) MUST use lower_snake_case naming convention. This ensures consistency and enhances readability for end users.

Following this convention, we make our mackerelotlp exporter callable under the type name mackerel_otlp. The old type name mackerelotlp will be retained as an alias and made available for a certain period.

The issue where warning messages appear when using the default settings for the OpenTelemetry Collector Mackerel will be addressed in a separate pull request (#106).

Test

In the default config of the Mackerel OpenTelemetry Collector, legacy component names (used as aliases) are still used, but they continue to work. The only difference is that a warning message is displayed.

$ docker run -e MACKEREL_APIKEY=dummy mackerel/otelcol-mackerel:latest-arm64
2026-01-27T12:43:54.628Z        warn    builders/builders.go:40 "mackerelotlp" alias is deprecated; use "mackerel_otlp" instead {"resource": {"service.instance.id": "4c83c942-49d5-4fad-a5f6-74a1b3c099ee", "service.name": "otelcol-mackerel", "service.version": "0.8.0"}, "otelcol.component.id": "mackerelotlp", "otelcol.component.kind": "exporter", "otelcol.signal": "traces"}
2026-01-27T12:43:54.628Z        info    builders/builders.go:28 Development component. May change in the future.       {"resource": {"service.instance.id": "4c83c942-49d5-4fad-a5f6-74a1b3c099ee", "service.name": "otelcol-mackerel", "service.version": "0.8.0"}, "otelcol.component.id": "mackerelotlp", "otelcol.component.kind": "exporter", "otelcol.signal": "traces"}
2026-01-27T12:43:54.629Z        warn    builders/builders.go:40 "mackerelotlp" alias is deprecated; use "mackerel_otlp" instead {"resource": {"service.instance.id": "4c83c942-49d5-4fad-a5f6-74a1b3c099ee", "service.name": "otelcol-mackerel", "service.version": "0.8.0"}, "otelcol.component.id": "mackerelotlp", "otelcol.component.kind": "exporter", "otelcol.signal": "metrics"}
2026-01-27T12:43:54.629Z        info    builders/builders.go:28 Development component. May change in the future.       {"resource": {"service.instance.id": "4c83c942-49d5-4fad-a5f6-74a1b3c099ee", "service.name": "otelcol-mackerel", "service.version": "0.8.0"}, "otelcol.component.id": "mackerelotlp", "otelcol.component.kind": "exporter", "otelcol.signal": "metrics"}
2026-01-27T12:43:54.630Z        info    service@v0.144.0/service.go:239 Starting otelcol-mackerel...    {"resource": {"service.instance.id": "4c83c942-49d5-4fad-a5f6-74a1b3c099ee", "service.name": "otelcol-mackerel", "service.version": "0.8.0"}, "Version": "0.8.0", "NumCPU": 14}
2026-01-27T12:43:54.630Z        info    extensions/extensions.go:40     Starting extensions...  {"resource": {"service.instance.id": "4c83c942-49d5-4fad-a5f6-74a1b3c099ee", "service.name": "otelcol-mackerel", "service.version": "0.8.0"}}
2026-01-27T12:43:54.630Z        info    internal/resourcedetection.go:160       began detecting resource information   {"resource": {"service.instance.id": "4c83c942-49d5-4fad-a5f6-74a1b3c099ee", "service.name": "otelcol-mackerel", "service.version": "0.8.0"}, "otelcol.component.id": "resourcedetection", "otelcol.component.kind": "processor", "otelcol.pipeline.id": "traces", "otelcol.signal": "traces"}
2026-01-27T12:43:54.631Z        info    internal/resourcedetection.go:217       detected resource information   {"resource": {"service.instance.id": "4c83c942-49d5-4fad-a5f6-74a1b3c099ee", "service.name": "otelcol-mackerel", "service.version": "0.8.0"}, "otelcol.component.id": "resourcedetection", "otelcol.component.kind": "processor", "otelcol.pipeline.id": "traces", "otelcol.signal": "traces", "resource": {"host.name":"f2e8301b21ad","os.type":"linux"}}
2026-01-27T12:43:54.631Z        info    internal/resourcedetection.go:160       began detecting resource information   {"resource": {"service.instance.id": "4c83c942-49d5-4fad-a5f6-74a1b3c099ee", "service.name": "otelcol-mackerel", "service.version": "0.8.0"}, "otelcol.component.id": "resourcedetection", "otelcol.component.kind": "processor", "otelcol.pipeline.id": "traces", "otelcol.signal": "traces"}
2026-01-27T12:43:54.631Z        info    internal/resourcedetection.go:217       detected resource information   {"resource": {"service.instance.id": "4c83c942-49d5-4fad-a5f6-74a1b3c099ee", "service.name": "otelcol-mackerel", "service.version": "0.8.0"}, "otelcol.component.id": "resourcedetection", "otelcol.component.kind": "processor", "otelcol.pipeline.id": "traces", "otelcol.signal": "traces", "resource": {"host.name":"f2e8301b21ad","os.type":"linux"}}
2026-01-27T12:43:54.631Z        info    otlpreceiver@v0.144.0/otlp.go:120       Starting GRPC server    {"resource": {"service.instance.id": "4c83c942-49d5-4fad-a5f6-74a1b3c099ee", "service.name": "otelcol-mackerel", "service.version": "0.8.0"}, "otelcol.component.id": "otlp", "otelcol.component.kind": "receiver", "endpoint": "127.0.0.1:4317"}
2026-01-27T12:43:54.632Z        info    otlpreceiver@v0.144.0/otlp.go:178       Starting HTTP server    {"resource": {"service.instance.id": "4c83c942-49d5-4fad-a5f6-74a1b3c099ee", "service.name": "otelcol-mackerel", "service.version": "0.8.0"}, "otelcol.component.id": "otlp", "otelcol.component.kind": "receiver", "endpoint": "127.0.0.1:4318"}
2026-01-27T12:43:54.632Z        info    service@v0.144.0/service.go:262 Everything is ready. Begin running and processing data. {"resource": {"service.instance.id": "4c83c942-49d5-4fad-a5f6-74a1b3c099ee", "service.name": "otelcol-mackerel", "service.version": "0.8.0"}}

@Arthur1 Arthur1 self-assigned this Jan 27, 2026
@Arthur1 Arthur1 added the minor label Jan 27, 2026
@Arthur1 Arthur1 force-pushed the component-name-convention branch from f96e706 to 9ac77dd Compare January 27, 2026 15:25
@Arthur1 Arthur1 force-pushed the component-name-convention branch from 9ac77dd to 5dab1d0 Compare January 28, 2026 02:42
@Arthur1 Arthur1 marked this pull request as ready for review January 28, 2026 02:53
@Arthur1 Arthur1 requested a review from a team as a code owner January 28, 2026 02:53
Copy link
Copy Markdown

@mrasu mrasu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Good catch!

@Arthur1 Arthur1 merged commit ffa5c23 into main Jan 28, 2026
5 checks passed
@Arthur1 Arthur1 deleted the component-name-convention branch January 28, 2026 08:11
@mackerelio-bot mackerelio-bot bot mentioned this pull request Jan 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants