Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[chore] Spelling #37128

Draft
wants to merge 450 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
450 commits
Select commit Hold shift + click to select a range
ed01f0c
spelling: library
jsoref Jan 3, 2025
ad4bbf8
spelling: listen
jsoref Jan 8, 2025
70bd1c8
spelling: loadbalancing
jsoref Jan 7, 2025
1cff2e3
spelling: lock
jsoref Jan 7, 2025
2e8c023
spelling: logdedupprocessor
jsoref Jan 8, 2025
4484c30
spelling: macos
jsoref Jan 3, 2025
791b19a
spelling: maintain
jsoref Jan 8, 2025
4de48bf
spelling: maintenance
jsoref Jan 8, 2025
b704c57
spelling: managed
jsoref Jan 8, 2025
c9dd85b
spelling: mandatory
jsoref Jan 8, 2025
ed6131f
spelling: marshaling
jsoref Jan 8, 2025
5657323
spelling: match
jsoref Jan 8, 2025
06784ab
spelling: math
jsoref Jan 3, 2025
3c48ad8
spelling: mccontainer
jsoref Jan 8, 2025
0410749
spelling: mdatagen
jsoref Jan 8, 2025
4bd7355
spelling: measurement
jsoref Jan 8, 2025
76815e2
spelling: mechanism
jsoref Jan 8, 2025
0520cab
spelling: memory
jsoref Jan 7, 2025
8f1d9f2
spelling: message
jsoref Jan 7, 2025
db0cc6a
spelling: messages
jsoref Jan 8, 2025
9ccd3de
spelling: metadata
jsoref Jan 8, 2025
bce124e
spelling: metrics
jsoref Jan 7, 2025
e76459d
spelling: metricsbuilder
jsoref Jan 7, 2025
17329da
spelling: metricstransform
jsoref Jan 8, 2025
3d27078
spelling: mezmoexporter
jsoref Jan 8, 2025
46c5b8f
spelling: milliseconds
jsoref Jan 8, 2025
d0665c4
spelling: minimal
jsoref Jan 7, 2025
b76656a
spelling: minimize
jsoref Jan 8, 2025
b0cc308
spelling: minimum
jsoref Jan 7, 2025
35ec70c
spelling: misleading
jsoref Jan 8, 2025
b361567
spelling: mismatch
jsoref Jan 7, 2025
92891fc
spelling: more useful
jsoref Jan 8, 2025
30d6219
spelling: mountpoints
jsoref Jan 7, 2025
56e5f94
spelling: multiple
jsoref Jan 8, 2025
182fc89
spelling: must
jsoref Jan 3, 2025
bfca3ce
spelling: name
jsoref Jan 7, 2025
5aa14da
spelling: namespace
jsoref Jan 8, 2025
265c4e4
spelling: neither-nor
jsoref Jan 3, 2025
ce04be5
spelling: nonexistent
jsoref Jan 3, 2025
9866156
spelling: nonexistent_pvc
jsoref Jan 7, 2025
c6b92f4
spelling: not
jsoref Jan 3, 2025
f1d4a95
spelling: number
jsoref Jan 8, 2025
07e88c5
spelling: occurred
jsoref Jan 8, 2025
c02e45b
spelling: occurring
jsoref Jan 8, 2025
530d21a
spelling: of
jsoref Jan 7, 2025
7ae8904
spelling: offset
jsoref Jan 7, 2025
b61eee9
spelling: omitted
jsoref Jan 8, 2025
424f79d
spelling: oops
jsoref Jan 7, 2025
7cfe9c8
spelling: openshift
jsoref Jan 8, 2025
4cc13f2
spelling: opentelemetry
jsoref Jan 7, 2025
f209440
spelling: operation
jsoref Jan 8, 2025
5f67793
spelling: operator
jsoref Jan 8, 2025
468c756
spelling: opportunity
jsoref Jan 8, 2025
941e022
spelling: option
jsoref Jan 8, 2025
651ad44
spelling: original
jsoref Jan 8, 2025
2af0163
spelling: other
jsoref Jan 8, 2025
392170d
spelling: otherattribs
jsoref Jan 8, 2025
0cd2bce
spelling: otherwise
jsoref Jan 7, 2025
c7d6342
spelling: output
jsoref Jan 8, 2025
988efc8
spelling: overwriting
jsoref Jan 8, 2025
2a9af68
spelling: package
jsoref Jan 8, 2025
2d95d22
spelling: parameter
jsoref Jan 8, 2025
3662dda
spelling: parsable
jsoref Jan 8, 2025
c246ae6
spelling: particular
jsoref Jan 8, 2025
cf083eb
spelling: partition
jsoref Jan 8, 2025
cf9663e
spelling: passthrough
jsoref Jan 7, 2025
5afbec4
spelling: path
jsoref Jan 7, 2025
0a71304
spelling: pattern
jsoref Jan 8, 2025
5fc7fb5
spelling: patterns
jsoref Jan 8, 2025
7204ce0
spelling: pending
jsoref Jan 8, 2025
7ae0f92
spelling: permanent
jsoref Jan 7, 2025
907a1b5
spelling: pipeline
jsoref Jan 8, 2025
a6b3b8d
spelling: populate
jsoref Jan 8, 2025
0752e47
spelling: preemptively
jsoref Jan 3, 2025
131ae42
spelling: preexisting
jsoref Jan 3, 2025
066349b
spelling: prefix
jsoref Jan 7, 2025
e3de7c9
spelling: prerequisites
jsoref Jan 7, 2025
a65417f
spelling: privileges
jsoref Jan 8, 2025
2427f10
spelling: probabilies
jsoref Jan 8, 2025
92609d1
spelling: probabilities
jsoref Jan 7, 2025
0ed2d43
spelling: process
jsoref Jan 7, 2025
98bee85
spelling: processor
jsoref Jan 7, 2025
8e13dce
spelling: profiles
jsoref Jan 8, 2025
46708f8
spelling: prometheus
jsoref Jan 7, 2025
c104721
spelling: propagated
jsoref Jan 8, 2025
dc5bf85
spelling: proportional
jsoref Jan 8, 2025
941b18d
spelling: provider
jsoref Jan 7, 2025
cdaffd5
spelling: querier
jsoref Jan 7, 2025
9c8121d
spelling: quotes
jsoref Jan 7, 2025
6c76179
spelling: randomness
jsoref Jan 7, 2025
77eed3f
spelling: reachable
jsoref Jan 7, 2025
f609a30
spelling: really, really,
jsoref Jan 3, 2025
32b2f53
spelling: received
jsoref Jan 7, 2025
1d47c19
spelling: receiver
jsoref Jan 7, 2025
4c3ef34
spelling: receiving
jsoref Jan 7, 2025
e1ff6b2
spelling: recombination
jsoref Jan 7, 2025
e12cad7
spelling: recommended
jsoref Jan 7, 2025
b5f96ff
spelling: record
jsoref Jan 7, 2025
bbbcac1
spelling: release
jsoref Jan 7, 2025
56a0754
spelling: replaces
jsoref Jan 7, 2025
22eba48
spelling: replicas
jsoref Jan 7, 2025
ef26a10
spelling: request
jsoref Jan 7, 2025
d0281dd
spelling: requests
jsoref Jan 7, 2025
7e69ce3
spelling: resource
jsoref Jan 7, 2025
78ffc65
spelling: resourceattribs
jsoref Jan 7, 2025
8a9a70e
spelling: response
jsoref Jan 7, 2025
9073b56
spelling: retrieval
jsoref Jan 7, 2025
ede7b84
spelling: retrieve
jsoref Jan 7, 2025
1d2177f
spelling: returns
jsoref Jan 7, 2025
8d81078
spelling: running
jsoref Jan 7, 2025
405b4b8
spelling: sarama
jsoref Jan 7, 2025
ea76fbb
spelling: scaling
jsoref Jan 8, 2025
a2cfc3e
spelling: schema
jsoref Jan 7, 2025
e53fef3
spelling: scheme
jsoref Jan 7, 2025
46fa062
spelling: schemes
jsoref Jan 7, 2025
51eb00b
spelling: scraper
jsoref Jan 7, 2025
83c5b3b
spelling: second
jsoref Jan 7, 2025
fee0447
spelling: see below for the
jsoref Jan 10, 2025
19a4477
spelling: segment
jsoref Jan 7, 2025
4f02277
spelling: segments
jsoref Jan 7, 2025
ac65459
spelling: sensible
jsoref Jan 7, 2025
7a15fc6
spelling: separate
jsoref Jan 7, 2025
9390621
spelling: separating
jsoref Jan 7, 2025
60d8347
spelling: service
jsoref Jan 7, 2025
f2576f8
spelling: session
jsoref Jan 7, 2025
3c0e52f
spelling: severity
jsoref Jan 7, 2025
e6500e7
spelling: shuts down
jsoref Jan 7, 2025
d367c5e
spelling: sigterm
jsoref Jan 7, 2025
36fab85
spelling: similar
jsoref Jan 8, 2025
2905cf3
spelling: skywalking
jsoref Jan 7, 2025
a5995a9
spelling: sources
jsoref Jan 8, 2025
8d73e88
spelling: specifies
jsoref Jan 8, 2025
52a29c9
spelling: specifying
jsoref Jan 8, 2025
23ff06a
spelling: splitlist
jsoref Jan 8, 2025
aa78152
spelling: stability
jsoref Jan 8, 2025
aceea7a
spelling: stacktrace
jsoref Jan 7, 2025
35ce97b
spelling: statement
jsoref Jan 8, 2025
ff9a14b
spelling: statements
jsoref Jan 7, 2025
84fa19c
spelling: stateset
jsoref Jan 7, 2025
c2b6d1b
spelling: statuses
jsoref Jan 8, 2025
c87f34f
spelling: still
jsoref Jan 3, 2025
a3e2747
spelling: storage
jsoref Jan 7, 2025
77d6f88
spelling: string
jsoref Jan 7, 2025
7e6a8dc
spelling: subsequent
jsoref Jan 8, 2025
09cb09d
spelling: success
jsoref Jan 7, 2025
006a264
spelling: successful
jsoref Jan 8, 2025
e2a8cdb
spelling: suffix
jsoref Jan 8, 2025
3fed9ae
spelling: support
jsoref Jan 8, 2025
c1b0eea
spelling: swallowing
jsoref Jan 8, 2025
4762452
spelling: symbols
jsoref Jan 8, 2025
29ac42c
spelling: synced
jsoref Jan 8, 2025
e04e8d9
spelling: synthetic
jsoref Jan 8, 2025
e33d4cc
spelling: target
jsoref Jan 8, 2025
38306e1
spelling: tasks
jsoref Jan 8, 2025
ed4fa1e
spelling: telemetry
jsoref Jan 8, 2025
ead30dc
spelling: template
jsoref Jan 7, 2025
41e4879
spelling: temporality
jsoref Jan 7, 2025
a5dd391
spelling: testbed
jsoref Jan 8, 2025
7bf1857
spelling: that
jsoref Jan 3, 2025
7c5d6de
spelling: the
jsoref Jan 3, 2025
9a8ea4a
spelling: throughput
jsoref Jan 8, 2025
74c0674
spelling: timeout
jsoref Jan 8, 2025
c5a0c7c
spelling: traces
jsoref Jan 7, 2025
fbeec37
spelling: transient
jsoref Jan 7, 2025
0392911
spelling: translate
jsoref Jan 7, 2025
6957f87
spelling: truncatable
jsoref Jan 8, 2025
ca2ecb5
spelling: truncation
jsoref Jan 8, 2025
f060513
spelling: uint
jsoref Jan 8, 2025
c46211f
spelling: unacked
jsoref Jan 7, 2025
c86bd50
spelling: unauthorized
jsoref Jan 7, 2025
d5bce6a
spelling: under
jsoref Jan 3, 2025
6577a8f
spelling: uniform
jsoref Jan 7, 2025
2e9166b
spelling: unmarshal
jsoref Jan 8, 2025
9680833
spelling: unmarshaller
jsoref Jan 7, 2025
def4ce8
spelling: uri
jsoref Jan 6, 2025
0ed9db6
spelling: url
jsoref Jan 5, 2025
954bcf1
spelling: used
jsoref Jan 8, 2025
bdd2b31
spelling: user
jsoref Jan 8, 2025
45845e9
spelling: utilization
jsoref Jan 7, 2025
19fc9c9
spelling: value
jsoref Jan 8, 2025
7728d28
spelling: values
jsoref Jan 8, 2025
c99ac8e
spelling: versions
jsoref Jan 8, 2025
a4866ef
spelling: wavefront
jsoref Jan 7, 2025
156cd66
spelling: when
jsoref Jan 3, 2025
31d9aa0
spelling: whereas
jsoref Jan 10, 2025
e6ae6fc
spelling: whether
jsoref Jan 7, 2025
1243c38
spelling: with
jsoref Jan 3, 2025
b19c602
spelling: without
jsoref Jan 6, 2025
0e35acc
spelling: won't
jsoref Jan 8, 2025
909e2c0
spelling: writing
jsoref Jan 8, 2025
62364c6
link: Detailed configuration examples are available
jsoref Jan 5, 2025
a69cae2
link: OpenTelemetry Logs Data Model specification
jsoref Jan 3, 2025
7ee5af6
link: Prometheus label names standard
jsoref Jan 3, 2025
3a6e445
link: Sentry Span
jsoref Jan 3, 2025
c62eb93
link: Sigv4 process
jsoref Jan 5, 2025
ef04971
link: SolarWinds Observability SaaS: Add a service
jsoref Jan 5, 2025
59dddc2
link: SolarWinds Observability SaaS: Data centers and endpoint URIs
jsoref Jan 5, 2025
d9b2d83
link: native otlphttp exporter
jsoref Jan 5, 2025
cd4f04f
link: What is the difference between MemFree and MemAvailable in /pro…
jsoref Jan 3, 2025
65012a8
link: `crosslink` tool README
jsoref Jan 3, 2025
a588ee8
link: authentication token provided by Splunk Observability Cloud
jsoref Jan 3, 2025
f73d439
link: batching configuration on the exporter
jsoref Jan 5, 2025
5e6958d
link: config.go
jsoref Jan 3, 2025
06c3660
link: default metrics
jsoref Jan 5, 2025
e592f51
link: distributor config parameter
jsoref Jan 3, 2025
10b5378
link: documentation on this functionality (and more keyword options)
jsoref Jan 3, 2025
6a6b9c0
link: elastic/go-grok: patterns/default.go
jsoref Jan 5, 2025
c67a59a
link: example overview
jsoref Jan 3, 2025
70f8d57
link: exceptionsconnector/config.go
jsoref Jan 3, 2025
eaa1c0f
link: exporter
jsoref Jan 5, 2025
238df7b
link: exporterhelper configuration parameters
jsoref Jan 3, 2025
59218a0
link: exporterhelper
jsoref Jan 3, 2025
7e654bc
link: full list of `ServerConfig`
jsoref Jan 3, 2025
1c025bb
link: github.com/bmatcuk/doublestar
jsoref Jan 5, 2025
8b7b185
link: grpc's
jsoref Jan 3, 2025
e42c302
link: how to configure the OpenTelemetry integration
jsoref Jan 3, 2025
d15e4fc
link: how to send logs to Grafana Loki using the OpenTelemetry Collector
jsoref Jan 3, 2025
2b0a137
link: instructions on how to fork
jsoref Jan 3, 2025
a3b5d83
link: interface for a Sentry Transaction
jsoref Jan 5, 2025
f208f06
link: json-schema.org/understanding-json-schema/reference/array
jsoref Jan 5, 2025
75d6302
link: offers proxy support
jsoref Jan 5, 2025
0257275
link: proxy support
jsoref Jan 3, 2025
ea6edb7
link: regexes.yaml
jsoref Jan 5, 2025
0568912
link: resourcemapping.go
jsoref Jan 3, 2025
e9fded9
link: signalfx/sapm-proto
jsoref Jan 3, 2025
328d831
link: spanmetricsconnector/config.go
jsoref Jan 3, 2025
bef18d2
link: specification
jsoref Jan 3, 2025
1ea96a8
link: By default, insecure settings are rejected and certificate veri…
jsoref Jan 5, 2025
1885486
link: DefaultMetricSettings
jsoref Jan 5, 2025
76c5ff8
link: DefaultMetricsSettings
jsoref Jan 5, 2025
2b0333c
link: Finer details are documented
jsoref Jan 5, 2025
3fe9fea
link: Grafana Dashboard for metrics from this receiver is on the mark…
jsoref Jan 5, 2025
7317865
link: Huawei Cloud region
jsoref Jan 5, 2025
c83edc7
link: Loki HTTP API: Ingest logs
jsoref Jan 5, 2025
46cee57
link: Prometheus license
jsoref Jan 5, 2025
d05c976
link: apache scoreboard
jsoref Jan 5, 2025
12568be
link: experimentalmetricmetadata/metadata.go
jsoref Jan 5, 2025
b16e2cf
link: expression language reference documentation
jsoref Jan 5, 2025
a1a9ed7
link: go sdk's default authentication mechanism
jsoref Jan 5, 2025
09a68c4
link: in-depth documentation on the allowable metrics
jsoref Jan 5, 2025
455c756
link: metadata.yaml
jsoref Jan 5, 2025
b9cac26
link: node conditions
jsoref Jan 5, 2025
31dd813
link: opentelemetry-collector-contrib#23565
jsoref Jan 5, 2025
39201e0
link: schema URL
jsoref Jan 5, 2025
639c8ea
link: signalfx/sapm-proto
jsoref Jan 5, 2025
5faa64c
link: special attribute names
jsoref Jan 5, 2025
5b62d50
link: sql/database
jsoref Jan 5, 2025
bad272e
link: testdata/config.yaml
jsoref Jan 3, 2025
bddeeb1
link: trace_to_envelope.go
jsoref Jan 3, 2025
ef2aede
link: moving the Sumo Logic exporter into this repository
jsoref Jan 9, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/new_component.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ body:
- type: textarea
attributes:
label: The purpose and use-cases of the new component
description: This information can be used later on to populate the README for the component. See an example overview [here](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/awsecscontainermetricsreceiver#overview).
description: This information can be used later on to populate the README for the component. See an [example overview](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/awsecscontainermetricsreceiver#overview).
validations:
required: true
- type: textarea
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build-and-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -615,7 +615,7 @@ jobs:
- name: Set Release Tag
id: github_tag
run: ./.github/workflows/scripts/set_release_tag.sh
- name: Create Github Release
- name: Create GitHub Release
run: |
gh release create $RELEASE_TAG -t $RELEASE_TAG -n "The OpenTelemetry Collector Contrib contains everything in the [opentelemetry-collector release](https://github.com/open-telemetry/opentelemetry-collector/releases/tag/$RELEASE_TAG), be sure to check the release notes there as well."
env:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/changelog.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This action requires that any PR targeting the main branch should add a
# yaml file to the ./.chloggen/ directory. If a CHANGELOG entry is not required,
# or if performing maintance on the Changelog, add either \"[chore]\" to the title of
# or if performing maintenance on the Changelog, add either \"[chore]\" to the title of
# the pull request or add the \"Skip Changelog\" label to disable this action.

name: changelog
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/telemetrygen.yml
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ jobs:
GOOS=linux GOARCH=amd64 make telemetrygen
GOOS=linux GOARCH=s390x make telemetrygen
cp bin/telemetrygen_* cmd/telemetrygen/
- name: Push telemetrygen to Github packages
- name: Push telemetrygen to GitHub packages
uses: docker/build-push-action@v6
with:
context: cmd/telemetrygen
Expand Down Expand Up @@ -143,7 +143,7 @@ jobs:
GOOS=linux GOARCH=amd64 make telemetrygen
GOOS=linux GOARCH=s390x make telemetrygen
cp bin/telemetrygen_* cmd/telemetrygen/
- name: Push telemetrygen to Github packages
- name: Push telemetrygen to GitHub packages
uses: docker/build-push-action@v6
with:
context: cmd/telemetrygen
Expand Down
6 changes: 3 additions & 3 deletions CHANGELOG-API.md
Original file line number Diff line number Diff line change
Expand Up @@ -492,9 +492,9 @@ If you are looking for user-facing changes, check out [CHANGELOG.md](./CHANGELOG
### 🚩 Deprecations 🚩

- `pkg/stanza`: Deprecate 'helper.EncodingConfig' and 'helper.NewEncodingConfig' (#25846)
- `pkg/stanza`: Deprecate encoding related elements of helper pacakge, in favor of new decoder package (#26019)
- `pkg/stanza`: Deprecate encoding related elements of helper package, in favor of new decoder package (#26019)
Includes the following deprecations | - Decoder - NewDecoder - LookupEncoding - IsNop
- `pkg/stanza`: Deprecate tokenization related elements of helper pacakge, in favor of new tokenize package (#25914)
- `pkg/stanza`: Deprecate tokenization related elements of helper package, in favor of new tokenize package (#25914)
Includes the following deprecations | - Flusher - FlusherConfig - NewFlusherConfig - Multiline - MultilineConfig - NewMultilineConfig - NewLineStartSplitFunc - NewLineEndSplitFunc - NewNewlineSplitFunc - Splitter - SplitterConfig - NewSplitterConfig - SplitNone

### 💡 Enhancements 💡
Expand Down Expand Up @@ -532,7 +532,7 @@ If you are looking for user-facing changes, check out [CHANGELOG.md](./CHANGELOG
### 💡 Enhancements 💡

- `changelog`: Generate separate changelogs for end users and package consumers (#24014)
- `splunkhecexporter`: Add heartbeat check while startup and new config param, heartbeat/startup (defaults to false). This is different than the healtcheck_startup, as the latter doesn't take token or index into account. (#24411)
- `splunkhecexporter`: Add heartbeat check while startup and new config param, heartbeat/startup (defaults to false). This is different than the healthcheck_startup, as the latter doesn't take token or index into account. (#24411)
- `k8sclusterreceiver`: Allows disabling metrics and resource attributes (#24568)
- `cmd/mdatagen`: Avoid reusing the same ResourceBuilder instance for multiple ResourceMetrics (#24762)

Expand Down
154 changes: 77 additions & 77 deletions CHANGELOG.md

Large diffs are not rendered by default.

24 changes: 11 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@ change. For instance:
### Description guidelines

When linking to an open issue, if your PR is meant to close said issue, please prefix your issue with one of the
following keywords: `Resolves`, `Fixes`, or `Closes`. More information on this functionality (and more keyword options) can be found
[here](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).
following keywords: `Resolves`, `Fixes`, or `Closes`. For more information, see the [documentation on this functionality (and more keyword options)](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).
This will automatically close the issue once your PR has been merged.

## Changelog
Expand Down Expand Up @@ -125,7 +124,7 @@ Components refer to connectors, exporters, extensions, processors, and receivers
* Implement the [component.Component](https://pkg.go.dev/go.opentelemetry.io/collector/component#Component) interface
* Provide a configuration structure which defines the configuration of the component
* Provide the implementation which performs the component operation
* Have a `metadata.yaml` file and its generated code (using [mdatadgen](https://github.com/open-telemetry/opentelemetry-collector/blob/main/cmd/mdatagen/README.md)).
* Have a `metadata.yaml` file and its generated code (using [mdatagen](https://github.com/open-telemetry/opentelemetry-collector/blob/main/cmd/mdatagen/README.md)).

Familiarize yourself with the interface of the component that you want to write, and use existing implementations as a reference.
[Building a Trace Receiver](https://opentelemetry.io/docs/collector/trace-receiver/) tutorial provides a detailed example of building a component.
Expand All @@ -152,15 +151,15 @@ and its contributors.
- Add a README.md on the root of your component describing its configuration and usage, likely referencing some of the
yaml files used in the component tests. We also suggest that the yaml files used in tests have comments for all
available configuration settings so users can copy and modify them as needed.
- Run `make crosslink` to update intra-repository dependencies. It will add a `replace` directive to `go.mod` file of every intra-repository dependant. This is necessary for your component to be included in the contrib executable.
- Run `make crosslink` to update intra-repository dependencies. It will add a `replace` directive to `go.mod` file of every intra-repository dependent. This is necessary for your component to be included in the contrib executable.
- Add your component to `versions.yaml`.
- All components included in the distribution must be included in
[`cmd/otelcontribcol/builder-config.yaml`](./cmd/otelcontribcol/builder-config.yaml)
and in the respective testing harnesses. To align with the test goal of the
project, components must be testable within the framework defined within the
folder. If a component can not be properly tested within the existing
folder. If a component cannot be properly tested within the existing
framework, it must increase the non testable components number with a comment
within the PR explaining as to why it can not be tested. **(Note: this does
within the PR explaining as to why it cannot be tested. **(Note: this does
not automatically include any components in official release binaries. See
[Releasing new components](#releasing-new-components).)**

Expand Down Expand Up @@ -241,14 +240,14 @@ to be included in the distributed otelcol-contrib binaries and docker images.

## Adding metrics to existing receivers
Following these steps for contributing additional metrics to existing receivers.
- Read instructions [here](https://github.com/open-telemetry/opentelemetry-collector/blob/main/CONTRIBUTING.md#fork) on how to
fork, build and create PRs. The only difference is to change repository name from `opentelemetry-collector` to `opentelemetry-collector-contrib`
- Read [instructions on how to fork
](https://github.com/open-telemetry/opentelemetry-collector/blob/main/CONTRIBUTING.md#fork), build and create PRs. The only difference is to change repository name from `opentelemetry-collector` to `opentelemetry-collector-contrib`
- Edit `metadata.yaml` of your metrics receiver to add new metrics, e.g.: `redisreceiver/metadata.yaml`
- To generate new metrics on top of this updated YAML file.
- Run `cd receiver/redisreceiver`
- Run `go generate ./...`
- Review the changed files and merge the changes into your forked repo.
- Create PR from Github web console following the instructions above.
- Create PR from GitHub web console following the instructions above.

## General Recommendations
Below are some recommendations that apply to typical components. These are not rigid rules and there are exceptions but
Expand All @@ -259,8 +258,7 @@ in general try to follow them.
- When implementing exporters try to leverage the exporter helpers from the core repo, see [exporterhelper
package](https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/exporterhelper). This will
ensure that the exporter provides [zPages](https://opencensus.io/zpages/) and a standard set of metrics.
- `replace` statements in `go.mod` files can be automatically inserted by running `make crosslink`. For more information
on the `crosslink` tool see the README [here](https://github.com/open-telemetry/opentelemetry-go-build-tools/tree/main/crosslink).
- `replace` statements in `go.mod` files can be automatically inserted by running `make crosslink`. For more information, see the [`crosslink` tool README](https://github.com/open-telemetry/opentelemetry-go-build-tools/tree/main/crosslink).

## Issue Triaging

Expand Down Expand Up @@ -340,9 +338,9 @@ Be sure to tag the existing Code Owners, if any, within the PR to ensure they re

### Emeritus roles

Contributors who are unable to meet the responsibilities of their role are encouraged to move to [emeritus](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#emeritus-maintainerapprovertriager). In case of long temporary absences, contributors are encouraged to let maintainers know on the CNCF Slack (e.g. on the #otel-collector-dev channel or privately via DM) and to mark themselves as 'Busy' on Github.
Contributors who are unable to meet the responsibilities of their role are encouraged to move to [emeritus](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#emeritus-maintainerapprovertriager). In case of long temporary absences, contributors are encouraged to let maintainers know on the CNCF Slack (e.g. on the #otel-collector-dev channel or privately via DM) and to mark themselves as 'Busy' on GitHub.

In the event that a contributor becomes inactive without prior notice, the maintainers will attempt to contact the contributor via both Github and the CNCF Slack to confirm their status. After two weeks, if the contributor is an approver or maintainer, they may be removed from the Github review auto-assignment.
In the event that a contributor becomes inactive without prior notice, the maintainers will attempt to contact the contributor via both GitHub and the CNCF Slack to confirm their status. After two weeks, if the contributor is an approver or maintainer, they may be removed from the GitHub review auto-assignment.

If the contributor does not respond within a period of two months, they may be moved to emeritus status at the discretion of the maintainers, following a majority vote among the maintainers (possibly excluding the contributor in question).

Expand Down
2 changes: 1 addition & 1 deletion cmd/githubgen/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ $> cd cmd/githubgen && $(GOCMD) install .
$> GITHUB_TOKEN=<mypattoken> githubgen --folder . [--allowlist cmd/githubgen/allowlist.txt]
```

## Checking codeowners against OpenTelemetry membership via Github API
## Checking codeowners against OpenTelemetry membership via GitHub API

To authenticate, set the environment variable `GITHUB_TOKEN` to a PAT token. If a PAT is not available you can use the `--skipgithub` flag to avoid checking for membership in the GitHub organization.

Expand Down
10 changes: 5 additions & 5 deletions cmd/githubgen/codeowners.go
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ const distributionCodeownersHeader = `
`

type codeownersGenerator struct {
skipGithub bool
skipGitHub bool
}

func (cg codeownersGenerator) generate(data *githubData) error {
Expand All @@ -92,7 +92,7 @@ func (cg codeownersGenerator) generate(data *githubData) error {
}
var missingCodeowners []string
var duplicateCodeowners []string
members, err := cg.getGithubMembers()
members, err := cg.getGitHubMembers()
if err != nil {
return err
}
Expand All @@ -110,7 +110,7 @@ func (cg codeownersGenerator) generate(data *githubData) error {
duplicateCodeowners = append(duplicateCodeowners, codeowner)
}
}
if len(missingCodeowners) > 0 && !cg.skipGithub {
if len(missingCodeowners) > 0 && !cg.skipGitHub {
sort.Strings(missingCodeowners)
return fmt.Errorf("codeowners are not members: %s", strings.Join(missingCodeowners, ", "))
}
Expand Down Expand Up @@ -190,8 +190,8 @@ LOOP:
return nil
}

func (cg codeownersGenerator) getGithubMembers() (map[string]struct{}, error) {
if cg.skipGithub {
func (cg codeownersGenerator) getGitHubMembers() (map[string]struct{}, error) {
if cg.skipGitHub {
// don't try to get organization members if no token is expected
return map[string]struct{}{}, nil
}
Expand Down
8 changes: 4 additions & 4 deletions cmd/githubgen/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,31 +24,31 @@ type generator interface {
generate(data *githubData) error
}

// Generates files specific to Github according to status metadata:
// Generates files specific to GitHub according to status metadata:
// .github/CODEOWNERS
// .github/ALLOWLIST
// .github/ISSUE_TEMPLATES/*.yaml (list of components)
// reports/distributions/*
func main() {
folder := flag.String("folder", ".", "folder investigated for codeowners")
allowlistFilePath := flag.String("allowlist", "cmd/githubgen/allowlist.txt", "path to a file containing an allowlist of members outside the OpenTelemetry organization")
skipGithubCheck := flag.Bool("skipgithub", false, "skip checking GitHub membership check for CODEOWNERS generator")
skipGitHubCheck := flag.Bool("skipgithub", false, "skip checking GitHub membership check for CODEOWNERS generator")
flag.Parse()
var generators []generator
for _, arg := range flag.Args() {
switch arg {
case "issue-templates":
generators = append(generators, issueTemplatesGenerator{})
case "codeowners":
generators = append(generators, codeownersGenerator{skipGithub: *skipGithubCheck})
generators = append(generators, codeownersGenerator{skipGitHub: *skipGitHubCheck})
case "distributions":
generators = append(generators, distributionsGenerator{})
default:
panic(fmt.Sprintf("Unknown generator: %s", arg))
}
}
if len(generators) == 0 {
generators = []generator{issueTemplatesGenerator{}, codeownersGenerator{skipGithub: *skipGithubCheck}}
generators = []generator{issueTemplatesGenerator{}, codeownersGenerator{skipGitHub: *skipGitHubCheck}}
}
if err := run(*folder, *allowlistFilePath, generators); err != nil {
log.Fatal(err)
Expand Down
10 changes: 5 additions & 5 deletions cmd/opampsupervisor/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# OpAMP Supervisor for the OpenTelemetry Collector

This is an implementation of an OpAMP Supervisor that runs a Collector instance using configuration provided from an OpAMP server. This implementation
is following a design specified [here](./specification/README.md).
is following a [specification](./specification/README.md).
The design is still undergoing changes, and as such this implementation may change as well.

## Experimenting with the supervisor
Expand All @@ -24,7 +24,7 @@ The supervisor is currently undergoing heavy development and is not ready for an
make otelcontribcol
```

3. Run the supervisor in the `cmd/opampsupervisor` directory of Collector contrib repository, substituting `<OS>` for your operating system (`darwin` for MacOS, `linux` or `windows`):
3. Run the supervisor in the `cmd/opampsupervisor` directory of Collector contrib repository, substituting `<OS>` for your operating system (`darwin` for macOS, `linux` or `windows`):

```shell
cd cmd/opampsupervisor
Expand All @@ -34,7 +34,7 @@ The supervisor is currently undergoing heavy development and is not ready for an
4. The supervisor should connect to the OpAMP server and start a Collector instance.

## Persistent data storage
The supervisor persists some data to disk in order to mantain state between restarts. The directory where this data is stored may be specified via the supervisor configuration:
The supervisor persists some data to disk in order to maintain state between restarts. The directory where this data is stored may be specified via the supervisor configuration:
```yaml
storage:
directory: "/path/to/storage/dir"
Expand Down Expand Up @@ -86,6 +86,6 @@ For a list of open issues related to the Supervisor, see [these issues](https://
| Starts and stops a Collector using remote configuration | ⚠️ |
| Communicates with OpAMP extension running in the Collector | <https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/21071> |
| Updates the Collector binary | 📅 |
| Configures the Collector to report it's own metrics over OTLP | 📅 |
| Configures the Collector to report it's own logs over OTLP | 📅 |
| Configures the Collector to report its own metrics over OTLP | 📅 |
| Configures the Collector to report its own logs over OTLP | 📅 |
| Sanitization or restriction of Collector config | <https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/24310> |
8 changes: 4 additions & 4 deletions cmd/opampsupervisor/e2e_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,7 @@ func TestSupervisorRestartsCollectorAfterBadConfig(t *testing.T) {
if ok {
// The effective config may be structurally different compared to what was sent,
// so just check that it includes some strings we know to be unique to the remote config.
return strings.Contains(cfg, "doesntexist")
return strings.Contains(cfg, "nonexistent")
}

return false
Expand Down Expand Up @@ -1225,14 +1225,14 @@ func TestSupervisorPersistsNewInstanceID(t *testing.T) {

t.Logf("Supervisor connected")

var newRecievedAgentID []byte
var newReceivedAgentID []byte
select {
case newRecievedAgentID = <-agentIDChan:
case newReceivedAgentID = <-agentIDChan:
case <-time.After(1 * time.Second):
t.Fatalf("failed to get second agent ID")
}

require.Equal(t, newID, uuid.UUID(newRecievedAgentID))
require.Equal(t, newID, uuid.UUID(newReceivedAgentID))
}

func TestSupervisorWritesAgentFilesToStorageDir(t *testing.T) {
Expand Down
8 changes: 4 additions & 4 deletions cmd/opampsupervisor/testdata/collector/bad_config.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
receivers:
doesntexist:
nonexistent:

exporters:
doesntexist:
nonexistent:

service:
pipelines:
traces:
receivers: [doesntexist]
exporters: [doesntexist]
receivers: [nonexistent]
exporters: [nonexistent]
2 changes: 1 addition & 1 deletion cmd/telemetrygen/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ You can build locally the Docker image with:
make docker-telemetrygen
```

Using github actions, we also push a docker image on commit to main or on release to this [Github docker registry](https://github.com/orgs/open-telemetry/packages/container/package/opentelemetry-collector-contrib%2Ftelemetrygen).
Using github actions, we also push a docker image on commit to main or on release to this [GitHub docker registry](https://github.com/orgs/open-telemetry/packages/container/package/opentelemetry-collector-contrib%2Ftelemetrygen).

## Running

Expand Down
Loading
Loading