Merge branch 'main' into add-splunk-rolling-restart-metric

Author: juanhotencoding

.chloggen/googlecloudlogentryencodingextension_alpha.yaml

@@ -0,0 +1,10 @@
+change_type: new_component
+
+component: googlecloudlogentryencodingextension
+
+note: Update stability to alpha.
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [37531]
+
+change_logs: [user]

.chloggen/googlecloudpubsubreceiver-deprecate-buildin.yaml

@@ -0,0 +1,13 @@
+change_type: deprecation
+
+component: googlecloudpubsubreceiver
+
+note: Add deprecation warning for the build-in encoders
+
+issues: [39371]
+
+subtext: |
+  The build-in encoders `cloud_logging` and `raw_text` both have encoding extension alternatives and will be removed
+  in version v0.132.0 of the collector.
+
+change_logs: [user]

.chloggen/pubsub-ignore-encoding-error.yaml

@@ -0,0 +1,16 @@
+change_type: breaking
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: googlecloudpubsubreceiver
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Add `ignore_encoding_error` configuration to ignore decoding failures from the configured encoder
+
+issues: [38164]
+
+subtext: |
+  Introduce a setting to ignore errors when the configured encoder. It's advised to set this to `true` when using 
+  a custom encoder, and use the new `receiver.googlecloudpubsub.encoding_error` metric to monitor the number of errors. 
+  Ignoring the error will cause the receiver to drop the message.
+
+change_logs: [user]

.chloggen/upgrade_prom_feature_gate.yaml

@@ -0,0 +1,32 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: breaking
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: receiver/prometheus
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Upgrade `receiver.prometheusreceiver.RemoveLegacyResourceAttributes` feature gate to `beta` stability (enabled by default)
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [32814]
+
+# (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: |
+  Disable the `receiver.promtheusreceiver.RemoveLegacyResourceAttributes` feature gate to restore previous behavior. This feature gate will be removed in a future release.
+  The feature gate is used to replace the following legacy resource attributes:
+  `net.host.name` -> `server.address`
+  `net.host.port` -> `server.port`
+  `http.scheme` -> `url.scheme`
+
+# 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: []

cmd/otelcontribcol/builder-config.yaml

@@ -54,6 +54,7 @@ extensions:
   - gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/encoding/textencodingextension v0.125.0
   - gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/encoding/zipkinencodingextension v0.125.0
   - gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/encoding/skywalkingencodingextension v0.125.0
+  - gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/encoding/googlecloudlogentryencodingextension v0.125.0
   - gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/k8sleaderelector v0.125.0
   - gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/cgroupruntimeextension v0.125.0
 

exporter/prometheusexporter/end_to_end_test.go

@@ -144,7 +144,7 @@ func TestEndToEndSummarySupport(t *testing.T) {
 		`test_up.instance="127.0.0.1:.*",job="otel-collector". 1 .*`,
 		`. HELP test_target_info Target metadata`,
 		`. TYPE test_target_info gauge`,
-		`test_target_info.http_scheme=\"http\",instance="127.0.0.1:.*",job="otel-collector",net_host_port=".*,server_port=".*",url_scheme="http". 1`,
+		`test_target_info.instance="127.0.0.1:.*",job="otel-collector",server_port=".*",url_scheme="http". 1`,
 	}
 
 	// 5.5: Perform a complete line by line prefix verification to ensure we extract back the inputs

extension/encoding/googlecloudlogentryencodingextension/README.md

@@ -3,12 +3,13 @@
 <!-- status autogenerated section -->
 | Status        |           |
 | ------------- |-----------|
-| Stability     | [development]  |
-| Distributions | [] |
+| Stability     | [alpha]  |
+| Distributions | [contrib] |
 | Issues        | [![Open issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aopen%20label%3Aextension%2Fgooglecloudlogentryencoding%20&label=open&color=orange&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aopen+is%3Aissue+label%3Aextension%2Fgooglecloudlogentryencoding) [![Closed issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aclosed%20label%3Aextension%2Fgooglecloudlogentryencoding%20&label=closed&color=blue&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aclosed+is%3Aissue+label%3Aextension%2Fgooglecloudlogentryencoding) |
 | [Code Owners](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#becoming-a-code-owner)    | [@alexvanboxel](https://www.github.com/alexvanboxel) |
 
-[development]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#development
+[alpha]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#alpha
+[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
 <!-- end autogenerated section -->
 
 This extension can be used fo unmarshaling a [Cloud Logging] [LogEntry] message type.

extension/encoding/googlecloudlogentryencodingextension/internal/metadata/generated_status.go

@@ -3,8 +3,8 @@ type: googlecloudlogentry_encoding
 status:
   class: extension
   stability:
-    development: [ extension ]
-  distributions: [ ]
+    alpha: [ extension ]
+  distributions: [ contrib ]
   codeowners:
     active: [ alexvanboxel ]
 

extension/encoding/googlecloudlogentryencodingextension/metadata.yaml

@@ -30,6 +30,9 @@ The following configuration options are supported:
   or switching between [global and regional service endpoints](https://cloud.google.com/pubsub/docs/reference/service_apis_overview#service_endpoints).
 * `insecure` (Optional): allows performing “insecure” SSL connections and transfers, useful when connecting to a local
    emulator instance. Only has effect if Endpoint is not ""
+* `ignore_encoding_error` (Optional): Ignore errors when the configured encoder fails to decoding a PubSub messages.
+  It's advised to set this to `true` when using a custom encoder, and use `receiver.googlecloudpubsub.encoding_error`
+  metric to monitor the number of errors. Ignoring the error will cause the receiver to drop the message.
 
 ```yaml
 receivers:
@@ -74,11 +77,12 @@ Extensions. The non OTLP build in encodings will be deprecated as soon as extens
 | raw_text          | Wrap in an OTLP log message                    |
 
 With `cloud_logging`, the receiver can be used to bring Cloud Logging messages into an OpenTelemetry pipeline. You'll
-first need to [set up a logging sink][sink-docs] with a Pub/Sub topic as its destination. Note that the `cloud_logging`
-integration is considered **alpha** as the semantic convention on some of the conversion are not stabilized yet.
+first need to [set up a logging sink][sink-docs] with a Pub/Sub topic as its destination. The build-in encoding is
+**deprecated** and will be removed in v0.132.0: Use the `googlecloudlogentry` encoding extension instead.
 
 With `raw_text`, the receiver can be used for ingesting arbitrary text message on a Pubsub subscription, wrapping them
-in OTLP Log messages.
+in OTLP Log messages.  The build-in encoding is **deprecated** and will be removed in v0.132.0: Use the `text` encoding
+extension instead.
 
 When no encoding is specified, the receiver will try to discover the type of the data by looking at the `ce-type` and
 `content-type` attributes of the message. These message attributes are set by the `googlepubsubexporter`.

receiver/googlecloudpubsubreceiver/README.md

@@ -31,6 +31,9 @@ type Config struct {
 	// Lock down the compression of the payload, leave empty for attribute based detection
 	Compression string `mapstructure:"compression"`
 
+	// Ignore errors when the configured encoder fails to decoding a PubSub messages
+	IgnoreEncodingError bool `mapstructure:"ignore_encoding_error"`
+
 	// The client id that will be used by Pubsub to make load balancing decisions
 	ClientID string `mapstructure:"client_id"`
 }

receiver/googlecloudpubsubreceiver/config.go

@@ -6,6 +6,18 @@
 
 The following telemetry is emitted by this component.
 
+### otelcol_receiver.googlecloudpubsub.encoding_error
+
+Number of times a message couldn't be decoded by the configured encoder
+
+The receiver reads messages from Google Cloud Pub/Sub and tries to decode the message using the configured
+encoder. Each time a message fails to decoded the counter is increased. 
+
+
+| Unit | Metric Type | Value Type | Monotonic |
+| ---- | ----------- | ---------- | --------- |
+| 1 | Sum | Int | true |
+
 ### otelcol_receiver.googlecloudpubsub.stream_restarts
 
 Number of times the stream (re)starts due to a Pub/Sub servers connection close

receiver/googlecloudpubsubreceiver/documentation.md

@@ -21,6 +21,16 @@ telemetry:
         The receiver uses the Google Cloud Pub/Sub StreamingPull API and keeps a open connection. The Pub/Sub servers
         recurrently close the connection after a time period to avoid a long-running sticky connection. This metric
         counts the number of the resets that occurred during the lifetime of the container.
+    receiver.googlecloudpubsub.encoding_error:
+      enabled: true
+      description: Number of times a message couldn't be decoded by the configured encoder
+      unit: "1"
+      sum:
+        value_type: int
+        monotonic: true
+      extended_documentation: |
+        The receiver reads messages from Google Cloud Pub/Sub and tries to decode the message using the configured
+        encoder. Each time a message fails to decoded the counter is increased. 
 
 tests:
   config:

receiver/googlecloudpubsubreceiver/internal/metadata/generated_telemetry.go

@@ -23,6 +23,8 @@ import (
 	"go.opentelemetry.io/collector/pdata/ptrace"
 	"go.opentelemetry.io/collector/receiver"
 	"go.opentelemetry.io/collector/receiver/receiverhelper"
+	"go.opentelemetry.io/otel/attribute"
+	"go.opentelemetry.io/otel/metric"
 
 	"github.com/open-telemetry/opentelemetry-collector-contrib/extension/encoding"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/googlecloudpubsubreceiver/internal"
@@ -181,8 +183,10 @@ func (receiver *pubsubReceiver) setMarshallerFromEncodingID(encodingID buildInEn
 		case otlpProtoLog:
 			receiver.logsUnmarshaler = &plog.ProtoUnmarshaler{}
 		case rawTextLog:
+			receiver.settings.Logger.Warn("build-in raw_text encoding is deprecated and will be removed in v0.132.0, use the text encoding extension instead")
 			receiver.logsUnmarshaler = unmarshalLogStrings{}
 		case cloudLogging:
+			receiver.settings.Logger.Warn("build-in cloud_logging encoding is deprecated and will be removed in v0.132.0, use the googlecloudlogentry encoding extension instead")
 			receiver.logsUnmarshaler = unmarshalCloudLoggingLogEntry{}
 		default:
 			return fmt.Errorf("cannot start receiver: build in encoding %s is not supported for logs", receiver.config.Encoding)
@@ -279,10 +283,14 @@ func (receiver *pubsubReceiver) handleTrace(ctx context.Context, payload []byte,
 		return err
 	}
 	otlpData, err := receiver.tracesUnmarshaler.UnmarshalTraces(payload)
-	count := otlpData.SpanCount()
 	if err != nil {
+		receiver.increaseEncodingErrorMetric(ctx, "traces")
+		if receiver.config.IgnoreEncodingError {
+			return nil
+		}
 		return err
 	}
+	count := otlpData.SpanCount()
 	ctx = receiver.obsrecv.StartTracesOp(ctx)
 	err = receiver.tracesConsumer.ConsumeTraces(ctx, otlpData)
 	receiver.obsrecv.EndTracesOp(ctx, reportFormatProtobuf, count, err)
@@ -295,10 +303,14 @@ func (receiver *pubsubReceiver) handleMetric(ctx context.Context, payload []byte
 		return err
 	}
 	otlpData, err := receiver.metricsUnmarshaler.UnmarshalMetrics(payload)
-	count := otlpData.MetricCount()
 	if err != nil {
+		receiver.increaseEncodingErrorMetric(ctx, "metrics")
+		if receiver.config.IgnoreEncodingError {
+			return nil
+		}
 		return err
 	}
+	count := otlpData.MetricCount()
 	ctx = receiver.obsrecv.StartMetricsOp(ctx)
 	err = receiver.metricsConsumer.ConsumeMetrics(ctx, otlpData)
 	receiver.obsrecv.EndMetricsOp(ctx, reportFormatProtobuf, count, err)
@@ -311,16 +323,29 @@ func (receiver *pubsubReceiver) handleLog(ctx context.Context, payload []byte, c
 		return err
 	}
 	otlpData, err := receiver.logsUnmarshaler.UnmarshalLogs(payload)
-	count := otlpData.LogRecordCount()
 	if err != nil {
+		receiver.increaseEncodingErrorMetric(ctx, "logs")
+		if receiver.config.IgnoreEncodingError {
+			return nil
+		}
 		return err
 	}
+	count := otlpData.LogRecordCount()
 	ctx = receiver.obsrecv.StartLogsOp(ctx)
 	err = receiver.logsConsumer.ConsumeLogs(ctx, otlpData)
 	receiver.obsrecv.EndLogsOp(ctx, reportFormatProtobuf, count, err)
 	return nil
 }
 
+func (receiver *pubsubReceiver) increaseEncodingErrorMetric(ctx context.Context, signal string) {
+	receiver.telemetryBuilder.ReceiverGooglecloudpubsubEncodingError.Add(ctx, 1,
+		metric.WithAttributes(
+			attribute.String("otelcol.component.kind", "receiver"),
+			attribute.String("otelcol.component.id", receiver.settings.ID.String()),
+			attribute.String("otelcol.signal", signal),
+		))
+}
+
 func (receiver *pubsubReceiver) detectEncoding(attributes map[string]string) (otlpEncoding buildInEncoding, otlpCompression buildInCompression) {
 	otlpEncoding = unknown
 	otlpCompression = uncompressed

receiver/googlecloudpubsubreceiver/internal/metadatatest/generated_telemetrytest.go

@@ -18,7 +18,7 @@ const removeOldSemconvFeatureGateID = "receiver.prometheusreceiver.RemoveLegacyR
 
 var removeOldSemconvFeatureGate = featuregate.GlobalRegistry().MustRegister(
 	removeOldSemconvFeatureGateID,
-	featuregate.StageAlpha,
+	featuregate.StageBeta,
 	featuregate.WithRegisterFromVersion("v0.101.0"),
 	featuregate.WithRegisterDescription("When enabled, the net.host.name, net.host.port, and http.scheme resource attributes are no longer added to metrics. Use server.address, server.port, and url.scheme instead."),
 	featuregate.WithRegisterReferenceURL("https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/32814"),

receiver/googlecloudpubsubreceiver/internal/metadatatest/generated_telemetrytest_test.go

@@ -628,9 +628,7 @@ func verifyHonorLabelsTrue(t *testing.T, td *testData, rms []pmetric.ResourceMet
 	expectedResourceAttributes.PutStr("service.name", "honor_labels_test")
 	expectedResourceAttributes.PutStr("service.instance.id", "hostname:8080")
 	expectedResourceAttributes.PutStr("server.port", "8080")
-	expectedResourceAttributes.PutStr("net.host.port", "8080")
 	expectedResourceAttributes.PutStr("server.address", "hostname")
-	expectedResourceAttributes.PutStr("net.host.name", "hostname")
 
 	expectedScrapeConfigAttributes := td.attributes
 
@@ -748,9 +746,7 @@ func verifyRelabelJobInstance(t *testing.T, td *testData, rms []pmetric.Resource
 	wantAttributes.PutStr("service.name", "not-target1")
 	wantAttributes.PutStr("service.instance.id", "relabeled-instance")
 	wantAttributes.PutStr("server.port", "")
-	wantAttributes.PutStr("net.host.port", "")
 	wantAttributes.PutStr("server.address", "relabeled-instance")
-	wantAttributes.PutStr("net.host.name", "relabeled-instance")
 
 	metrics1 := rms[0].ScopeMetrics().At(0).Metrics()
 	ts1 := metrics1.At(0).Gauge().DataPoints().At(0).Timestamp()

receiver/googlecloudpubsubreceiver/metadata.yaml

@@ -605,7 +605,7 @@ the Pod level hints are used as a fallback (see detailed example below).
 
 The current implementation relies on the implementation of `k8sobserver` extension and specifically
 the [pod_endpoint](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.111.0/extension/observer/k8sobserver/pod_endpoint.go).
-The hints are evaluated per container by extracting the annotations from each [`Pod Container` endpoint](#Pod Container) that is emitted.
+The hints are evaluated per container by extracting the annotations from each [`Pod Container` endpoint](#pod-container) that is emitted.
 
 
 ### Examples
@@ -748,4 +748,4 @@ spec:
             - name: redis
               containerPort: 6379
               protocol: TCP
-```
+```