Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zcong1993/opentelemetry-instrumentation-egg
OpenTelemetry Instrumentation for Egg.js
https://github.com/zcong1993/opentelemetry-instrumentation-egg
Last synced: about 23 hours ago
JSON representation
OpenTelemetry Instrumentation for Egg.js
- Host: GitHub
- URL: https://github.com/zcong1993/opentelemetry-instrumentation-egg
- Owner: zcong1993
- License: mit
- Created: 2021-05-30T15:54:25.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-23T17:48:46.000Z (16 days ago)
- Last Synced: 2024-10-24T01:58:18.326Z (15 days ago)
- Language: TypeScript
- Homepage:
- Size: 396 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# opentelemetry-instrumentation-egg
[](https://npmjs.com/package/opentelemetry-instrumentation-egg) [](https://npmjs.com/package/opentelemetry-instrumentation-egg) [](https://github.com/zcong1993/opentelemetry-instrumentation-egg/actions/workflows/js-test.yml)
This module provides automatic instrumentation for [`Egg`](https://github.com/eggjs/egg).
For automatic instrumentation see the
[@opentelemetry/node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.
Since `Egg` is based on [`Koa`](https://github.com/koajs/koa) packaging, we also based it on [opentelemetry-instrumentation-koa](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-koa), just adjusting some details and adaptations.
## Installation
This instrumentation relies on HTTP calls to also be instrumented. Make sure you install and enable both, otherwise you will not see any spans being exported from the instrumentation.
```bash
npm install --save @opentelemetry/instrumentation-http opentelemetry-instrumentation-egg
```
### Supported Versions
- `^4.20.0`
## Usage
OpenTelemetry Egg Instrumentation allows the user to automatically collect trace data and export them to their backend of choice, to give observability to distributed systems.
To load the instrumentation, specify it in the Node Tracer's configuration:
```js
const { NodeTracerProvider } = require('@opentelemetry/node')
const { registerInstrumentations } = require('@opentelemetry/instrumentation')
const { HttpInstrumentation } = require('@opentelemetry/instrumentation-http')
const { EggInstrumentation } = require('opentelemetry-instrumentation-egg')
const provider = new NodeTracerProvider()
provider.register()
registerInstrumentations({
instrumentations: [
// Egg instrumentation expects HTTP layer to be instrumented
new HttpInstrumentation(),
new EggInstrumentation(),
],
})
```
### Egg Instrumentation Options
Egg instrumentation has few options available to choose from. You can set the following:
| Options | Type | Example | Description |
| ------------------ | ----------------- | --------------------- | -------------------------------- |
| `ignoreLayers` | `IgnoreMatcher[]` | `[/^\/_internal\//]` | Ignore layers that by match. |
| `ignoreLayersType` | `KoaLayerType[]` | `['request_handler']` | Ignore layers of specified type. |
`ignoreLayers` accepts an array of elements of types:
- `string` for full match of the path,
- `RegExp` for partial match of the path,
- `function` in the form of `(path) => boolean` for custom logic.
`ignoreLayersType` accepts an array of following strings:
- `router` is the name of `egg app.Router`,
- `middleware`,
By default, we disable the following `egg` default middlewares:
```ts
export const defaultConfig: EggInstrumentationConfig = {
ignoreLayers: [
(name: string) => {
return [
'middleware - meta',
'middleware - siteFile',
'middleware - notfound',
'middleware - static',
'middleware - overrideMethod',
'middleware - session',
'middleware - i18n',
'middleware - bodyParser',
'middleware - securities',
'middleware - eggLoaderTrace',
].includes(name)
},
],
}
```
## Useful links
- For more information on OpenTelemetry, visit:
- For more about OpenTelemetry JavaScript:
## References
- [opentelemetry-instrumentation-koa](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-koa)
- [opentelemetry-instrumentation-express](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-express)
## License
MIT © zcong1993