Skip to content

Commit e9a428b

Browse files
blakerousemwear
andauthored
[extension/healthcheckv2extension] Refactor internal/status to pkg/status (#35648)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description Refactors the `extension/healthcheckv2extension/internal/status` into `pkg/status`. This exposes the aggregator to be used by other extensions to gather component status information using the `extension.StatusWatcher`. <!-- Issue number (e.g. #1234) or full URL to issue, if applicable. --> #### Link to tracking issue Closes #34692 <!--Describe what testing was performed and which tests were added.--> #### Testing Being it was a refactor and all the same tests provided coverage, no additional testing was added. <!--Describe the documentation added.--> #### Documentation Added a `README.md` to the `pkg/status` to provide information on where this package can be used. --------- Co-authored-by: Matthew Wear <[email protected]>
1 parent 86699bd commit e9a428b

33 files changed

+293
-87
lines changed

.chloggen/pkg-status.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
4+
change_type: new_component
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
7+
component: pkg/status
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: Refactors the extension/healthcheckv2extension/internal/status into pkg/status
11+
12+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
13+
issues: [34692]
14+
15+
# (Optional) One or more lines of additional information to render under the primary note.
16+
# These lines will be padded with 2 spaces and then inserted directly into the document.
17+
# Use pipe (|) for multiline entries.
18+
subtext:
19+
20+
# If your change doesn't affect end users or the exported elements of any package,
21+
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
22+
# Optional: The change log or logs in which this entry should be included.
23+
# e.g. '[user]' or '[user, api]'
24+
# Include 'user' if the change is relevant to end users.
25+
# Include 'api' if there is a change to a library API.
26+
# Default: '[user]'
27+
change_logs: [api]

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,7 @@ pkg/resourcetotelemetry/ @open-teleme
156156
pkg/sampling/ @open-telemetry/collector-contrib-approvers @kentquirk @jmacd
157157
pkg/stanza/ @open-telemetry/collector-contrib-approvers @djaglowski
158158
pkg/stanza/fileconsumer/ @open-telemetry/collector-contrib-approvers @djaglowski
159+
pkg/status/ @open-telemetry/collector-contrib-approvers @jpkrohling @mwear
159160
pkg/translator/azure/ @open-telemetry/collector-contrib-approvers @open-telemetry/collector-approvers @atoulme @cparkins
160161
pkg/translator/azurelogs/ @open-telemetry/collector-contrib-approvers @atoulme @cparkins @MikeGoldsmith
161162
pkg/translator/jaeger/ @open-telemetry/collector-contrib-approvers @open-telemetry/collector-approvers @frzifus

.github/ISSUE_TEMPLATE/bug_report.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,7 @@ body:
152152
- pkg/sampling
153153
- pkg/stanza
154154
- pkg/stanza/fileconsumer
155+
- pkg/status
155156
- pkg/translator/azure
156157
- pkg/translator/azurelogs
157158
- pkg/translator/jaeger

.github/ISSUE_TEMPLATE/feature_request.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,7 @@ body:
146146
- pkg/sampling
147147
- pkg/stanza
148148
- pkg/stanza/fileconsumer
149+
- pkg/status
149150
- pkg/translator/azure
150151
- pkg/translator/azurelogs
151152
- pkg/translator/jaeger

.github/ISSUE_TEMPLATE/other.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,7 @@ body:
146146
- pkg/sampling
147147
- pkg/stanza
148148
- pkg/stanza/fileconsumer
149+
- pkg/status
149150
- pkg/translator/azure
150151
- pkg/translator/azurelogs
151152
- pkg/translator/jaeger

.github/ISSUE_TEMPLATE/unmaintained.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,7 @@ body:
151151
- pkg/sampling
152152
- pkg/stanza
153153
- pkg/stanza/fileconsumer
154+
- pkg/status
154155
- pkg/translator/azure
155156
- pkg/translator/azurelogs
156157
- pkg/translator/jaeger

cmd/otelcontribcol/builder-config.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -496,3 +496,4 @@ replaces:
496496
- github.com/open-telemetry/opentelemetry-collector-contrib/receiver/githubreceiver => ../../receiver/githubreceiver
497497
- github.com/open-telemetry/opentelemetry-collector-contrib/internal/grpcutil => ../../internal/grpcutil
498498
- github.com/open-telemetry/opentelemetry-collector-contrib/receiver/googlecloudmonitoringreceiver => ../../receiver/googlecloudmonitoringreceiver
499+
- github.com/open-telemetry/opentelemetry-collector-contrib/pkg/status => ../../pkg/status

extension/healthcheckv2extension/extension.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import (
1616

1717
"github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckv2extension/internal/grpc"
1818
"github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckv2extension/internal/http"
19-
"github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckv2extension/internal/status"
19+
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/status"
2020
)
2121

2222
type eventSourcePair struct {

extension/healthcheckv2extension/extension_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ import (
2020
"go.opentelemetry.io/collector/confmap/confmaptest"
2121
"go.opentelemetry.io/collector/extension/extensiontest"
2222

23-
"github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckv2extension/internal/status"
24-
"github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckv2extension/internal/testhelpers"
2523
"github.com/open-telemetry/opentelemetry-collector-contrib/internal/common/testutil"
24+
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/status"
25+
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/status/testhelpers"
2626
)
2727

2828
func TestComponentStatus(t *testing.T) {

extension/healthcheckv2extension/go.mod

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ go 1.22.0
44

55
require (
66
github.com/open-telemetry/opentelemetry-collector-contrib/internal/common v0.111.0
7+
github.com/open-telemetry/opentelemetry-collector-contrib/pkg/status v0.111.0
78
github.com/stretchr/testify v1.9.0
89
go.opentelemetry.io/collector/component v0.111.1-0.20241008154146-ea48c09c31ae
910
go.opentelemetry.io/collector/component/componentstatus v0.111.1-0.20241008154146-ea48c09c31ae
@@ -14,7 +15,6 @@ require (
1415
go.opentelemetry.io/collector/confmap v1.17.1-0.20241008154146-ea48c09c31ae
1516
go.opentelemetry.io/collector/extension v0.111.1-0.20241008154146-ea48c09c31ae
1617
go.opentelemetry.io/collector/extension/extensioncapabilities v0.111.1-0.20241008154146-ea48c09c31ae
17-
go.opentelemetry.io/collector/pipeline v0.111.1-0.20241008154146-ea48c09c31ae
1818
go.uber.org/goleak v1.3.0
1919
go.uber.org/multierr v1.11.0
2020
go.uber.org/zap v1.27.0
@@ -51,6 +51,7 @@ require (
5151
go.opentelemetry.io/collector/featuregate v1.17.1-0.20241008154146-ea48c09c31ae // indirect
5252
go.opentelemetry.io/collector/internal/globalsignal v0.111.1-0.20241008154146-ea48c09c31ae // indirect
5353
go.opentelemetry.io/collector/pdata v1.17.1-0.20241008154146-ea48c09c31ae // indirect
54+
go.opentelemetry.io/collector/pipeline v0.111.1-0.20241008154146-ea48c09c31ae // indirect
5455
go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.55.0 // indirect
5556
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.55.0 // indirect
5657
go.opentelemetry.io/otel v1.30.0 // indirect
@@ -67,3 +68,5 @@ require (
6768
)
6869

6970
replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/common => ../../internal/common
71+
72+
replace github.com/open-telemetry/opentelemetry-collector-contrib/pkg/status => ../../pkg/status

0 commit comments

Comments
 (0)