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

feat: ignore_message_queues configuration #2008

Merged
merged 10 commits into from
Mar 22, 2021
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions docs/configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -933,3 +933,33 @@ During startup the Node.js agent queries the local environment to determine whet
- `none`: Do not query for any cloud provider information.

If the value is not one of the five listed above, the agent will use the value of `auto`.

[[ignore_message_queues]]
astorm marked this conversation as resolved.
Show resolved Hide resolved
astorm marked this conversation as resolved.
Show resolved Hide resolved
==== `ignoreMessageQueues`
* *Type:* Array
* *Default:* `[]`
* *Env:* `ELASTIC_IGNORE_MESSAGE_QUEUES`

astorm marked this conversation as resolved.
Show resolved Hide resolved
Array or comma-separated string of wildcard patterns that tell the agent to
ignore certain queues/topics when instrumenting messaging systems.

When an instrumented messaging system sends or receives a message, the agent
will test the queue/topic name against each wildcard in this list. If
the name matches the agent will skip instrumenting the operation.
astorm marked this conversation as resolved.
Show resolved Hide resolved

The `ignoreMessageQueues` property supports simple wildcard (`*`) patterns, and
may not include commas. Wildcard matches are case-insensitive by default. You
may make wildcard searches case-sensitive by using the `(?-i)` prefix.

Example usage:

[source,js]
----
require('elastic-apm-node').start({
ignoreMessageQueues: [
'overnight_jobs',
'events_*',
'(?-i)/caseSensitiveSearch'
astorm marked this conversation as resolved.
Show resolved Hide resolved
]
})
----
1 change: 1 addition & 0 deletions index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,7 @@ interface AgentConfigOptions {
frameworkVersion?: string;
globalLabels?: KeyValueConfig;
hostname?: string;
ignoreMessageQueues?: Array<string>;
ignoreUrls?: Array<string | RegExp>;
ignoreUserAgents?: Array<string | RegExp>;
instrument?: boolean;
Expand Down
17 changes: 16 additions & 1 deletion lib/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ var DEFAULTS = {
errorOnAbortedRequests: false,
filterHttpHeaders: true,
globalLabels: undefined,
ignoreMessageQueues: [],
instrument: true,
instrumentIncomingHTTPRequests: true,
kubernetesNamespace: undefined,
Expand Down Expand Up @@ -106,6 +107,7 @@ var ENV_TABLE = {
cloudProvider: 'ELASTIC_APM_CLOUD_PROVIDER',
disableInstrumentations: 'ELASTIC_APM_DISABLE_INSTRUMENTATIONS',
environment: 'ELASTIC_APM_ENVIRONMENT',
ignoreMessageQueues: 'ELASTIC_IGNORE_MESSAGE_QUEUES',
errorMessageMaxLength: 'ELASTIC_APM_ERROR_MESSAGE_MAX_LENGTH',
errorOnAbortedRequests: 'ELASTIC_APM_ERROR_ON_ABORTED_REQUESTS',
filterHttpHeaders: 'ELASTIC_APM_FILTER_HTTP_HEADERS',
Expand Down Expand Up @@ -201,7 +203,8 @@ var MINUS_ONE_EQUAL_INFINITY = [
var ARRAY_OPTS = [
'disableInstrumentations',
'sanitizeFieldNames',
'transactionIgnoreUrls'
'transactionIgnoreUrls',
'ignoreMessageQueues'
]

var KEY_VALUE_OPTS = [
Expand All @@ -221,6 +224,7 @@ class Config {
this.ignoreUserAgentRegExp = []
this.transactionIgnoreUrlRegExp = []
this.sanitizeFieldNamesRegExp = []
this.ignoreMessageQueuesRegExp = []
// If we didn't find a config file on process boot, but a path to one is
// provided as a config option, let's instead try to load that
if (confFile === null && opts && opts.configFile) {
Expand Down Expand Up @@ -491,6 +495,17 @@ function normalizeIgnoreOptions (opts) {
}
delete opts.ignoreUserAgents
}

if (opts.ignoreMessageQueues) {
if (!opts.ignoreMessageQueuesRegExp) {
opts.ignoreMessageQueuesRegExp = []
}
const wildcard = new WildcardMatcher()
for (const ptn of opts.ignoreMessageQueues) {
const re = wildcard.compile(ptn)
opts.ignoreMessageQueuesRegExp.push(re)
}
}
}

function normalizeNumbers (opts) {
Expand Down
67 changes: 67 additions & 0 deletions test/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -1060,6 +1060,73 @@ test('should accept and normalize cloudProvider', function (t) {
delete process.env.ELASTIC_APM_CLOUD_PROVIDER
t.end()
})

test('should accept and normalize ignoreMessageQueues', function (suite) {
suite.test('ignoreMessageQueues defaults', function (t) {
const agent = Agent()
agent.start()
t.equals(
agent._conf.ignoreMessageQueues.length,
0,
'ignore message queue defaults empty'
)

t.equals(
agent._conf.ignoreMessageQueuesRegExp.length,
0,
'ignore message queue regex defaults empty'
)
t.end()
})

suite.test('ignoreMessageQueues via configuration', function (t) {
const agent = Agent()
agent.start({ ignoreMessageQueues: ['f*o', 'bar'] })
t.equals(
agent._conf.ignoreMessageQueues.length,
2,
'ignore message picks up configured values'
)

t.equals(
agent._conf.ignoreMessageQueuesRegExp.length,
2,
'ignore message queue regex picks up configured values'
)

t.ok(
agent._conf.ignoreMessageQueuesRegExp[0].test('faooooo'),
'wildcard converted to regular expression'
)
t.end()
})

suite.test('ignoreMessageQueues via env', function (t) {
const agent = Agent()
process.env.ELASTIC_IGNORE_MESSAGE_QUEUES = 'f*o,bar,baz'
agent.start()
t.equals(
agent._conf.ignoreMessageQueues.length,
3,
'ignore message queue picks up env values'
)

t.equals(
agent._conf.ignoreMessageQueuesRegExp.length,
3,
'ignore message queue regex picks up env values'
)

t.ok(
agent._conf.ignoreMessageQueuesRegExp[0].test('faooooo'),
'wildcard converted to regular expression'
)
t.end()
})

suite.end()
})

function assertEncodedTransaction (t, trans, result) {
t.comment('transaction')
t.strictEqual(result.id, trans.id, 'id matches')
Expand Down