Skip to content

Commit

Permalink
Marking instanaexporter module as deprecated (open-telemetry#35052)
Browse files Browse the repository at this point in the history
**Description:** <Describe what has changed.>
Follow open-telemetry#18503, Marking instanaexporter module as deprecated.

**Link to tracking Issue:** open-telemetry#34994

**Testing:** <Describe what testing was performed and which tests were
added.>

**Documentation:** <Describe the documentation added.>

Signed-off-by: Murphy Chen <[email protected]>
  • Loading branch information
Frapschen authored and f7o committed Sep 12, 2024
1 parent bfdf241 commit 60b7480
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .chloggen/mark-instana-exporter-module-deprecated.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: deprecation

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: instanaexporter

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Marking instanaexporter module as deprecated

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [34994]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: []
11 changes: 11 additions & 0 deletions exporter/instanaexporter/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ package instanaexporter // import "github.com/open-telemetry/opentelemetry-colle

import (
"context"
"sync"
"time"

"go.opentelemetry.io/collector/component"
Expand All @@ -16,10 +17,13 @@ import (
"go.opentelemetry.io/collector/consumer"
"go.opentelemetry.io/collector/exporter"
"go.opentelemetry.io/collector/exporter/exporterhelper"
"go.uber.org/zap"

"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/instanaexporter/internal/metadata"
)

var once sync.Once

// NewFactory creates an Instana exporter factory
func NewFactory() exporter.Factory {
return exporter.NewFactory(
Expand All @@ -41,13 +45,20 @@ func createDefaultConfig() component.Config {
}
}

func logDeprecation(logger *zap.Logger) {
once.Do(func() {
logger.Warn("instana exporter is deprecated and will be removed in the next release. See https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/34994 for more details.")
})
}

// createTracesExporter creates a trace exporter based on this configuration
func createTracesExporter(ctx context.Context, set exporter.Settings, config component.Config) (exporter.Traces, error) {
cfg := config.(*Config)

ctx, cancel := context.WithCancel(ctx)

instanaExporter := newInstanaExporter(cfg, set)
logDeprecation(set.Logger)

return exporterhelper.NewTracesExporter(
ctx,
Expand Down
1 change: 1 addition & 0 deletions exporter/instanaexporter/go.mod
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// Deprecated: [v0.109.0] This package is deprecated and will be removed in the next release.
module github.com/open-telemetry/opentelemetry-collector-contrib/exporter/instanaexporter

go 1.22.0
Expand Down

0 comments on commit 60b7480

Please sign in to comment.