Skip to content

Commit 1b4999f

Browse files
docs: spelling corrections (open-telemetry#4530)
* docs: spelling corrections * chore: feedback on spelling changes
1 parent 7fa2c84 commit 1b4999f

File tree

36 files changed

+59
-59
lines changed

36 files changed

+59
-59
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ An entry into `CHANGELOG.md` or `experimental/CHANGELOG.md` is required for the
104104
- Changes to default settings
105105
- New components being added
106106

107-
It is reasonable to omit an entry to the changelog under these circuimstances:
107+
It is reasonable to omit an entry to the changelog under these circumstances:
108108

109109
- Updating test to remove flakiness or improve coverage
110110
- Updates to the CI/CD process

api/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ npm install @opentelemetry/api @opentelemetry/sdk-trace-base
3636

3737
### Trace Your Application
3838

39-
In order to get started with tracing, you will need to first register an SDK. The SDK you are using may provide a convenience method which calls the registration methods for you, but if you would like to call them directly they are documented here: [sdk registration methods][docs-sdk-registration].
39+
In order to get started with tracing, you will need to first register an SDK. The SDK you are using may provide a convenience method which calls the registration methods for you, but if you would like to call them directly they are documented here: [SDK registration methods][docs-sdk-registration].
4040

4141
Once you have registered an SDK, you can start and end spans. A simple example of basic SDK registration and tracing a simple operation is below. The example should export spans to the console once per second. For more information, see the [tracing documentation][docs-tracing].
4242

api/test/common/metrics/Metric.test.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ describe('Metric', () => {
4242
const counter: Counter<Attributes> = {
4343
add(_value: number, _attribute: Attributes) {},
4444
};
45-
// @ts-expect-error Expacting the type of Attributes
45+
// @ts-expect-error Expecting the type of Attributes
4646
counter.add(1, { 'another-attribute': 'value' });
4747
});
4848
});
@@ -72,7 +72,7 @@ describe('Metric', () => {
7272
const counter: UpDownCounter<Attributes> = {
7373
add(_value: number, _attribute: Attributes) {},
7474
};
75-
// @ts-expect-error Expacting the type of Attributes
75+
// @ts-expect-error Expecting the type of Attributes
7676
counter.add(1, { 'another-attribute': 'value' });
7777
});
7878
});
@@ -102,7 +102,7 @@ describe('Metric', () => {
102102
const counter: Histogram<Attributes> = {
103103
record(_value: number, _attribute: Attributes) {},
104104
};
105-
// @ts-expect-error Expacting the type of Attributes
105+
// @ts-expect-error Expecting the type of Attributes
106106
counter.record(1, { 'another-attribute': 'value' });
107107
});
108108
});

doc/upgrade-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Collector exporter packages and types are renamed:
107107

108108
- All plugins have been removed in favor of instrumentations.
109109

110-
- The `@opentelemetry/propagator-b3` package previously exported three propagators: `B3Propagator`,`B3SinglePropagator`, and `B3MultiPropagator`, but now only exports the `B3Propagator`. It extracts b3 context in single and multi-header encodings, and injects context using the single-header encoding by default, but can be configured to inject context using the multi-header endcoding during construction: `new B3Propagator({ injectEncoding: B3InjectEncoding.MULTI_HEADER })`. If you were previously using the `B3SinglePropagator` or `B3MultiPropagator` directly, you should update your code to use the `B3Propagator` with the appropriate configuration. See the [readme][otel-propagator-b3] for full details and usage.
110+
- The `@opentelemetry/propagator-b3` package previously exported three propagators: `B3Propagator`,`B3SinglePropagator`, and `B3MultiPropagator`, but now only exports the `B3Propagator`. It extracts b3 context in single and multi-header encodings, and injects context using the single-header encoding by default, but can be configured to inject context using the multi-header encoding during construction: `new B3Propagator({ injectEncoding: B3InjectEncoding.MULTI_HEADER })`. If you were previously using the `B3SinglePropagator` or `B3MultiPropagator` directly, you should update your code to use the `B3Propagator` with the appropriate configuration. See the [README][otel-propagator-b3] for full details and usage.
111111

112112
- Sampling configuration via environment variable has changed. If you were using `OTEL_SAMPLING_PROBABILITY` then you should replace it with `OTEL_TRACES_SAMPLER=parentbased_traceidratio` and `OTEL_TRACES_SAMPLER_ARG=<number>` where `<number>` is a number in the [0..1] range, e.g. "0.25". Default is 1.0 if unset.
113113

@@ -232,7 +232,7 @@ Some types exported from `"@opentelemetry/api"` have been changed to be more spe
232232

233233
## 0.15.0 to 0.16.0
234234

235-
[PR-1863](https://github.com/open-telemetry/opentelemetry-js/pull/1863) removed public attributes `keepAlive` and `httpAgentOptions` from nodejs `CollectorTraceExporter` and `CollectorMetricExporter`
235+
[PR-1863](https://github.com/open-telemetry/opentelemetry-js/pull/1863) removed public attributes `keepAlive` and `httpAgentOptions` from Node.js `CollectorTraceExporter` and `CollectorMetricExporter`
236236

237237
## 0.14.0 to 0.15.0
238238

experimental/packages/opentelemetry-browser-detector/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,4 @@ start().then(()=> console.log("Instrumentation started"));
5151

5252
The browser identification attributes will be added to the resource spans when traces are created.
5353
These attributes include platform, brands, mobile, language if the browser supports
54-
the userAgentData api, otherwise it will contain only the user_agent informations
54+
the userAgentData api, otherwise it will contain only the user_agent information

experimental/packages/opentelemetry-browser-detector/src/types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export type UserAgentData = {
2020
};
2121

2222
export const BROWSER_ATTRIBUTES = {
23-
PLATFORM: 'browser.platform', //TODO replace with SemantecConventions attribute when available
23+
PLATFORM: 'browser.platform', //TODO replace with SemanticConventions attribute when available
2424
BRANDS: 'browser.brands',
2525
MOBILE: 'browser.mobile',
2626
LANGUAGE: 'browser.language',

experimental/packages/opentelemetry-instrumentation-fetch/test/fetch.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -654,7 +654,7 @@ describe('fetch', () => {
654654
clearData();
655655
});
656656

657-
it('applies attributes when the request is succesful', async () => {
657+
it('applies attributes when the request is successful', async () => {
658658
await prepare(url, span => {
659659
span.setAttribute(CUSTOM_ATTRIBUTE_KEY, 'custom value');
660660
});

experimental/packages/opentelemetry-instrumentation-grpc/src/clientUtils.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ export function patchResponseStreamEvents(span: Span, call: EventEmitter) {
152152
}
153153

154154
/**
155-
* Execute grpc client call. Apply completitionspan properties and end the
155+
* Execute grpc client call. Apply completion span properties and end the
156156
* span on callback or receiving an emitted event.
157157
*/
158158
export function makeGrpcClientRemoteCall(

experimental/packages/opentelemetry-instrumentation-grpc/test/helper.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ export async function startServer(proto: any, port: number) {
136136
server.addService(proto.GrpcTester.service, {
137137
// An error is emitted every time
138138
// request.num <= MAX_ERROR_STATUS = (status.UNAUTHENTICATED)
139-
// in those cases, erro.code = request.num
139+
// in those cases, error.code = request.num
140140

141141
// This method returns the request
142142
// This method returns the request

experimental/packages/opentelemetry-instrumentation-http/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ The following options are deprecated:
6767
| Options | Type | Description |
6868
| ------- | ---- | ----------- |
6969
| `ignoreIncomingPaths` | `IgnoreMatcher[]` | Http instrumentation will not trace all incoming requests that match paths |
70-
| `ignoreOutgoingUrls` | `IgnoreMatcher[]` | Http instrumentation will not trace all outgoing requests that match urls |
70+
| `ignoreOutgoingUrls` | `IgnoreMatcher[]` | Http instrumentation will not trace all outgoing requests that match URLs |
7171

7272
## Useful links
7373

0 commit comments

Comments
 (0)