[processor/resourcedetection] fail to start the processor if the ec2 detector fails to start because network is unreachable

Author: atoulme

.chloggen/detect_network_error.yaml

@@ -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: bug_fix
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: resourcedetectionprocessor
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Return an error when trying to start the processor with the ec2 detector while the network is not reachable
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [35936]
+
+# (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: []

processor/resourcedetectionprocessor/go.mod

@@ -10,6 +10,7 @@ require (
 	github.com/aws/aws-sdk-go-v2/config v1.29.1
 	github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.16.24
 	github.com/aws/aws-sdk-go-v2/service/ec2 v1.200.0
+	github.com/aws/smithy-go v1.22.1
 	github.com/google/go-cmp v0.6.0
 	github.com/hashicorp/consul/api v1.31.0
 	github.com/open-telemetry/opentelemetry-collector-contrib/internal/aws/ecsutil v0.118.0
@@ -55,7 +56,6 @@ require (
 	github.com/aws/aws-sdk-go-v2/service/sso v1.24.11 // indirect
 	github.com/aws/aws-sdk-go-v2/service/ssooidc v1.28.10 // indirect
 	github.com/aws/aws-sdk-go-v2/service/sts v1.33.9 // indirect
-	github.com/aws/smithy-go v1.22.1 // indirect
 	github.com/cenkalti/backoff/v4 v4.3.0 // indirect
 	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
 	github.com/distribution/reference v0.5.0 // indirect

processor/resourcedetectionprocessor/internal/aws/ec2/ec2.go

@@ -5,6 +5,7 @@ package ec2 // import "github.com/open-telemetry/opentelemetry-collector-contrib
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"net/http"
 	"regexp"
@@ -13,6 +14,7 @@ import (
 	"github.com/aws/aws-sdk-go-v2/config"
 	"github.com/aws/aws-sdk-go-v2/service/ec2"
 	"github.com/aws/aws-sdk-go-v2/service/ec2/types"
+	smithyhttp "github.com/aws/smithy-go/transport/http"
 	"go.opentelemetry.io/collector/pdata/pcommon"
 	"go.opentelemetry.io/collector/processor"
 	conventions "go.opentelemetry.io/collector/semconv/v1.6.1"
@@ -79,6 +81,11 @@ func NewDetector(set processor.Settings, dcfg internal.DetectorConfig) (internal
 
 func (d *Detector) Detect(ctx context.Context) (resource pcommon.Resource, schemaURL string, err error) {
 	if _, err = d.metadataProvider.InstanceID(ctx); err != nil {
+		var requestSendError *smithyhttp.RequestSendError
+		if errors.As(err, &requestSendError) {
+			d.logger.Warn("EC2 metadata endpoint unreachable", zap.Error(err))
+			return pcommon.NewResource(), "", err
+		}
 		d.logger.Debug("EC2 metadata unavailable", zap.Error(err))
 		return pcommon.NewResource(), "", nil
 	}

processor/resourcedetectionprocessor/internal/aws/ec2/ec2_test.go

@@ -14,6 +14,7 @@ import (
 	"github.com/aws/aws-sdk-go-v2/feature/ec2/imds"
 	"github.com/aws/aws-sdk-go-v2/service/ec2"
 	ec2types "github.com/aws/aws-sdk-go-v2/service/ec2/types"
+	smithyhttp "github.com/aws/smithy-go/transport/http"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"go.opentelemetry.io/collector/pdata/pcommon"
@@ -30,10 +31,9 @@ type mockMetadata struct {
 	retIDDoc    imds.InstanceIdentityDocument
 	retErrIDDoc error
 
-	retHostname    string
-	retErrHostname error
-
-	isAvailable bool
+	retHostname       string
+	retErrHostname    error
+	retErrUnavailable error
 }
 
 var _ ec2provider.Provider = (*mockMetadata)(nil)
@@ -51,10 +51,7 @@ func (e *mockClientBuilderError) buildClient(_ context.Context, _ string, _ *htt
 }
 
 func (mm mockMetadata) InstanceID(_ context.Context) (string, error) {
-	if !mm.isAvailable {
-		return "", errUnavailable
-	}
-	return "", nil
+	return "", mm.retErrUnavailable
 }
 
 func (mm mockMetadata) Get(_ context.Context) (imds.InstanceIdentityDocument, error) {
@@ -173,7 +170,6 @@ func TestDetector_Detect(t *testing.T) {
 					InstanceType:     "c4.xlarge",
 				},
 				retHostname: "example-hostname",
-				isAvailable: true,
 			}},
 			args: args{ctx: context.Background()},
 			want: func() pcommon.Resource {
@@ -203,7 +199,6 @@ func TestDetector_Detect(t *testing.T) {
 					InstanceType:     "c4.xlarge",
 				},
 				retHostname: "example-hostname",
-				isAvailable: true,
 			}},
 			tagKeyRegexes: []*regexp.Regexp{regexp.MustCompile("^tag1$"), regexp.MustCompile("^tag2$")},
 			args:          args{ctx: context.Background()},
@@ -237,7 +232,6 @@ func TestDetector_Detect(t *testing.T) {
 					InstanceType:     "c4.xlarge",
 				},
 				retHostname: "example-hostname",
-				isAvailable: true,
 			}},
 			args: args{ctx: context.Background()},
 			want: func() pcommon.Resource {
@@ -259,20 +253,29 @@ func TestDetector_Detect(t *testing.T) {
 		{
 			name: "endpoint not available",
 			fields: fields{metadataProvider: &mockMetadata{
-				retIDDoc:    imds.InstanceIdentityDocument{},
-				retErrIDDoc: errors.New("should not be called"),
-				isAvailable: false,
+				retIDDoc:          imds.InstanceIdentityDocument{},
+				retErrIDDoc:       errors.New("should not be called"),
+				retErrUnavailable: errUnavailable,
 			}},
 			args:    args{ctx: context.Background()},
 			want:    pcommon.NewResource(),
 			wantErr: false,
 		},
+		{
+			name: "network not ready",
+			fields: fields{metadataProvider: &mockMetadata{
+				retIDDoc:          imds.InstanceIdentityDocument{},
+				retErrUnavailable: &smithyhttp.RequestSendError{Err: errors.New("nope")},
+			}},
+			args:    args{ctx: context.Background()},
+			want:    pcommon.NewResource(),
+			wantErr: true,
+		},
 		{
 			name: "get fails",
 			fields: fields{metadataProvider: &mockMetadata{
 				retIDDoc:    imds.InstanceIdentityDocument{},
 				retErrIDDoc: errors.New("get failed"),
-				isAvailable: true,
 			}},
 			args:    args{ctx: context.Background()},
 			want:    pcommon.NewResource(),
@@ -284,7 +287,6 @@ func TestDetector_Detect(t *testing.T) {
 				retIDDoc:       imds.InstanceIdentityDocument{},
 				retHostname:    "",
 				retErrHostname: errors.New("hostname failed"),
-				isAvailable:    true,
 			}},
 			args:    args{ctx: context.Background()},
 			want:    pcommon.NewResource(),