Skip to content

Commit

Permalink
Verify spelling fixes pass check-spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
jsoref authored Jan 10, 2025
2 parents 0eb768b + ef2aede commit 62a96ff
Show file tree
Hide file tree
Showing 587 changed files with 1,398 additions and 1,416 deletions.
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

0 comments on commit 62a96ff

Please sign in to comment.