-
Notifications
You must be signed in to change notification settings - Fork 825
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(plugin): implement redis plugin (#503)
* feat(plugin): implement redis plugin * fix: circle redis testing * fix: set span error status * fix: run the redis service * fix: linting * feat: add redis error handling statuses * fix: pr comments * fix: redis linting * refactor: move patches to utils for clarity * fix: linting
- Loading branch information
1 parent
724f9cc
commit fa583fd
Showing
11 changed files
with
697 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| /*! | ||
| * Copyright 2019, OpenTelemetry Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| export enum AttributeNames { | ||
| // required by https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/data-semantic-conventions.md#databases-client-calls | ||
| COMPONENT = 'component', | ||
| DB_TYPE = 'db.type', | ||
| DB_INSTANCE = 'db.instance', | ||
| DB_STATEMENT = 'db.statement', | ||
| PEER_ADDRESS = 'peer.address', | ||
| PEER_HOSTNAME = 'peer.host', | ||
|
|
||
| // optional | ||
| DB_USER = 'db.user', | ||
| PEER_PORT = 'peer.port', | ||
| PEER_IPV4 = 'peer.ipv4', | ||
| PEER_IPV6 = 'peer.ipv6', | ||
| PEER_SERVICE = 'peer.service', | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| /*! | ||
| * Copyright 2019, OpenTelemetry Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import { BasePlugin } from '@opentelemetry/core'; | ||
| import * as redisTypes from 'redis'; | ||
| import * as shimmer from 'shimmer'; | ||
| import { | ||
| getTracedCreateClient, | ||
| getTracedCreateStreamTrace, | ||
| getTracedInternalSendCommand, | ||
| } from './utils'; | ||
|
|
||
| export class RedisPlugin extends BasePlugin<typeof redisTypes> { | ||
| static readonly COMPONENT = 'redis'; | ||
| readonly supportedVersions = ['^2.6.0']; // equivalent to >= 2.6.0 <3 | ||
|
|
||
| constructor(readonly moduleName: string) { | ||
| super(); | ||
| } | ||
|
|
||
| protected patch() { | ||
| if (this._moduleExports.RedisClient) { | ||
| this._logger.debug( | ||
| 'Patching redis.RedisClient.prototype.internal_send_command' | ||
| ); | ||
| shimmer.wrap( | ||
| this._moduleExports.RedisClient.prototype, | ||
| 'internal_send_command', | ||
| this._getPatchInternalSendCommand() | ||
| ); | ||
|
|
||
| this._logger.debug('patching redis.create_stream'); | ||
| shimmer.wrap( | ||
| this._moduleExports.RedisClient.prototype, | ||
| 'create_stream', | ||
| this._getPatchCreateStream() | ||
| ); | ||
|
|
||
| this._logger.debug('patching redis.createClient'); | ||
| shimmer.wrap( | ||
| this._moduleExports, | ||
| 'createClient', | ||
| this._getPatchCreateClient() | ||
| ); | ||
| } | ||
| return this._moduleExports; | ||
| } | ||
|
|
||
| protected unpatch(): void { | ||
| if (this._moduleExports) { | ||
| shimmer.unwrap( | ||
| this._moduleExports.RedisClient.prototype, | ||
| 'internal_send_command' | ||
| ); | ||
| shimmer.unwrap( | ||
| this._moduleExports.RedisClient.prototype, | ||
| 'create_stream' | ||
| ); | ||
| shimmer.unwrap(this._moduleExports, 'createClient'); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Patch internal_send_command(...) to trace requests | ||
| */ | ||
| private _getPatchInternalSendCommand() { | ||
| const tracer = this._tracer; | ||
| return function internal_send_command(original: Function) { | ||
| return getTracedInternalSendCommand(tracer, original); | ||
| }; | ||
| } | ||
|
|
||
| private _getPatchCreateClient() { | ||
| const tracer = this._tracer; | ||
| return function createClient(original: Function) { | ||
| return getTracedCreateClient(tracer, original); | ||
| }; | ||
| } | ||
|
|
||
| private _getPatchCreateStream() { | ||
| const tracer = this._tracer; | ||
| return function createReadStream(original: Function) { | ||
| return getTracedCreateStreamTrace(tracer, original); | ||
| }; | ||
| } | ||
| } | ||
|
|
||
| export const plugin = new RedisPlugin(RedisPlugin.COMPONENT); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| /*! | ||
| * Copyright 2019, OpenTelemetry Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import * as redisTypes from 'redis'; | ||
| import { EventEmitter } from 'events'; | ||
|
|
||
| // exported from | ||
| // https://github.com/NodeRedis/node_redis/blob/master/lib/command.js | ||
| export interface RedisCommand { | ||
| command: string; | ||
| args: string[]; | ||
| buffer_args: boolean; | ||
| callback: redisTypes.Callback<unknown>; | ||
| call_on_write: boolean; | ||
| } | ||
|
|
||
| export interface RedisPluginClientTypes { | ||
| options?: { | ||
| host: string; | ||
| port: string; | ||
| }; | ||
|
|
||
| address?: string; | ||
| } | ||
|
|
||
| export interface RedisPluginStreamTypes { | ||
| stream?: { get(): EventEmitter; set(val: EventEmitter): void }; | ||
| } |
Oops, something went wrong.