Skip to content

Commit d5da949

Browse files
committed
fix: Typos
1 parent 031928b commit d5da949

File tree

73 files changed

+110
-110
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+110
-110
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ When contributing to this repository, please ensure that your commit messages ad
7575
* `style` - changes that do not affect the meaning of the code (e.g. formatting, white-space, etc.)
7676
* `test` - adding new tests or modifying existing tests
7777
* Use the imperative, present tense (e.g. "add feature" instead of "added feature")
78-
* Optionally, include a scope in parantheses after the type to indicate which part of the repository is affected (e.g. `feat(instrumentation): add support for Prisma Client`)
78+
* Optionally, include a scope in parentheses after the type to indicate which part of the repository is affected (e.g. `feat(instrumentation): add support for Prisma Client`)
7979

8080
Please note that we use the [Squash and Merge](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-commits) method when merging Pull Requests into the main branch. We do not use the original commit messages from each individual commit. Instead, we use the Pull Request title as the commit message for the squashed commit, and as such, require that the Pull Request title adheres to our Conventional Commit standards. Any additional documentation or information relevant to the release notes should be added to the "optional extended description" section of the squash commit on merge.
8181

bin/create-github-release.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ async function createRelease() {
6868
console.log('*** Full Run Successful ***')
6969
} catch (err) {
7070
if (err.status && err.status === 404) {
71-
console.log('404 status error detected. For octokit, this may mean insuffient permissions.')
71+
console.log('404 status error detected. For octokit, this may mean insufficient permissions.')
7272
console.log('Ensure you have a valid GITHUB_TOKEN set in your env vars.')
7373
}
7474

bin/pending-prs.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,11 +134,11 @@ async function findMergedPRs(repo, ignoredLabels) {
134134

135135
const filteredPullRequests = mergedPullRequests.filter((pr) => {
136136
// Find all PRs without an ignored label
137-
const withIngored = pr.labels.some(({ name }) => ignoredLabels.includes(name))
137+
const withIgnored = pr.labels.some(({ name }) => ignoredLabels.includes(name))
138138

139139
// Sometimes the commit for the PR the tag is set to has an earlier time than
140140
// the PR merge time and we'll pull in release note PRs. Filters those out.
141-
return pr.merge_commit_sha !== tag.commit.sha && !withIngored
141+
return pr.merge_commit_sha !== tag.commit.sha && !withIgnored
142142
})
143143

144144
console.log(`Found ${filteredPullRequests.length} PRs not yet released.`)

documentation/function-wrapping.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ const newrelic = require('newrelic');
2121
const agent = require.cache.__NR_cache.agent;
2222
const Shim = require('newrelic/lib/shim/shim');
2323

24-
// do the same fnApply/apply shenangins as the shim library
24+
// do the same fnApply/apply shenanigans as the shim library
2525
// https://github.com/newrelic/node-newrelic/blob/v7.1.3/lib/shim/shim.js#L17-L19
2626
const fnApply = Function.prototype.apply
2727

documentation/nextjs/faqs/instrument-third-party-libraries.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Q: How can I get instrumentation to load for 3rd party libraries within my Next.js application like mysql, mongodb, pino, winston, etc?
44

5-
A: Typically the New Relic Node.js agent auto-instruments all supported [3rd party libraries](https://docs.newrelic.com/docs/apm/agents/nodejs-agent/getting-started/compatibility-requirements-nodejs-agent/#instrument). Next.js, however, bundles your project and code spilts between server and client side via webpack. To get auto-instrumentation to work, you must externalize all libraries within webpack.
5+
A: Typically the New Relic Node.js agent auto-instruments all supported [3rd party libraries](https://docs.newrelic.com/docs/apm/agents/nodejs-agent/getting-started/compatibility-requirements-nodejs-agent/#instrument). Next.js, however, bundles your project and code splits between server and client side via webpack. To get auto-instrumentation to work, you must externalize all libraries within webpack.
66

77
## Externalize 3rd party libraries in webpack
88

examples/instrumentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ We have moved our examples and tutorials over to [newrelic-node-examples](https:
77
* [instrumentWebframework](https://github.com/newrelic/newrelic-node-examples/tree/main/custom-instrumentation/instrument-webframework) - example application that uses the [newrelic.instrumentWebframework API](https://newrelic.github.io/node-newrelic/API.html#instrumentWebframework) and associated [WebFramework shim API](https://newrelic.github.io/node-newrelic/WebFrameworkShim.html) to instrument a hypothetical web framework
88
* [attributesAndEvents](https://github.com/newrelic/newrelic-node-examples/tree/main/custom-instrumentation/attributes-and-events) - example application that demonstrates how to share custom [attributes](https://newrelic.github.io/node-newrelic/API.html#addCustomAttribute) and [events](https://newrelic.github.io/node-newrelic/API.html#recordCustomEvent)
99
* [backgroundTransactions](https://github.com/newrelic/newrelic-node-examples/tree/main/custom-instrumentation/background-transactions) - example application that uses the newrelic API to create [background transactions](https://newrelic.github.io/node-newrelic/API.html#startBackgroundTransaction)
10-
* [segments](https://github.com/newrelic/newrelic-node-examples/tree/main/custom-instrumentation/segments) - example application that demonstrates how to use the [newrelic.startSegment API](https://newrelic.github.io/node-newrelic/API.html#startSegment) in a variety of cases: callback-based, promise-based, asyncronously, and syncronously
10+
* [segments](https://github.com/newrelic/newrelic-node-examples/tree/main/custom-instrumentation/segments) - example application that demonstrates how to use the [newrelic.startSegment API](https://newrelic.github.io/node-newrelic/API.html#startSegment) in a variety of cases: callback-based, promise-based, asynchronously, and synchronously
1111
* [distributed tracing](https://github.com/newrelic/newrelic-node-examples/tree/main/custom-instrumentation/distributed-tracing) - example application that demonstrates distributed tracing
1212

1313
To request additional examples, please [file an issue](https://github.com/newrelic/node-newrelic/issues)!

lib/agent.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -444,7 +444,7 @@ Agent.prototype._scheduleHarvests = function _scheduleHarvests(shouldImmediately
444444

445445
const agent = this
446446

447-
// For data collection that streams immediately, dont delay capture/sending until
447+
// For data collection that streams immediately, don't delay capture/sending until
448448
// the harvest of everything else has completed.
449449
agent.startStreaming()
450450

@@ -564,7 +564,7 @@ Agent.prototype._resetCustomEvents = function resetCustomEvents() {
564564
* @fires Agent#harvestFinished
565565
*/
566566
Agent.prototype.harvestSync = function harvestSync() {
567-
logger.trace('Peparing to harvest.')
567+
logger.trace('Preparing to harvest.')
568568

569569
if (!this.collector.isConnected()) {
570570
throw new Error('Sync harvest not connected/enabled!')

lib/collector/remote-method.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ RemoteMethod.prototype._safeRequest = function _safeRequest(options) {
260260
level = 'info'
261261
}
262262

263-
// check if trace is enabled or audit log(aka info in this case) before attemping
263+
// check if trace is enabled or audit log(aka info in this case) before attempting
264264
// to get the body length or parse the path with redacted key
265265
if (logger.traceEnabled() || level === 'info') {
266266
const logBody = Buffer.isBuffer(options.body) ? 'Buffer ' + options.body.length : options.body

lib/config/default.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,7 @@ defaultConfig.definition = () => {
323323
*/
324324
diagnostics: {
325325
formatter: boolean,
326-
deafult: false
326+
default: false
327327
}
328328
},
329329
audit_log: {
@@ -1145,7 +1145,7 @@ defaultConfig.definition = () => {
11451145
/**
11461146
* Controls whether the agent will generate spans for in-process actions.
11471147
* When disabled, this will only create spans for entry and exit spans.
1148-
* entry spans - initial actions for web servers and messsage queue consumption.
1148+
* entry spans - initial actions for web servers and message queue consumption.
11491149
* exit spans - all outgoing calls to external services(external and database calls)
11501150
*/
11511151
in_process_spans: {
@@ -1399,7 +1399,7 @@ defaultConfig.definition = () => {
13991399
/**
14001400
* Obfuscates URL parameters
14011401
* for outgoing and incoming requests
1402-
* for distrubuted tracing attributes - both transaction and span attributes
1402+
* for distributed tracing attributes - both transaction and span attributes
14031403
* for transaction trace transaction details
14041404
*/
14051405
url_obfuscation: {
@@ -1429,7 +1429,7 @@ defaultConfig.definition = () => {
14291429

14301430
/**
14311431
* A string containing a replacement value for URL parameters
1432-
* can contain refferences to capture groups in the pattern
1432+
* can contain references to capture groups in the pattern
14331433
*/
14341434
replacement: {
14351435
default: ''
@@ -1499,7 +1499,7 @@ defaultConfig.definition = () => {
14991499
},
15001500

15011501
/**
1502-
* Unique test identifier when runnning IAST with CI/CD
1502+
* Unique test identifier when running IAST with CI/CD
15031503
*/
15041504
iast_test_identifier: '',
15051505

lib/config/hsm.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ const REDACT_BEFORE_SEND = new Set([
7171
'certificates' // should be public but in case user mistake and also these are huge
7272
])
7373

74-
// process.domain needs to be stripped befeore sending
74+
// process.domain needs to be stripped before sending
7575
const REMOVE_BEFORE_SEND = new Set(['domain'])
7676

7777
exports.HIGH_SECURITY_SETTINGS = HIGH_SECURITY_SETTINGS

0 commit comments

Comments
 (0)