Skip to content

Commit 59628bb

Browse files
authored
chore: mark plugin koa unmaintained (#1513)
1 parent 750bdad commit 59628bb

File tree

1 file changed

+9
-5
lines changed
  • plugins/node/opentelemetry-instrumentation-koa

1 file changed

+9
-5
lines changed

plugins/node/opentelemetry-instrumentation-koa/README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@ This module provides automatic instrumentation for the [Koa](https://github.com/
77

88
If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](`https://www.npmjs.com/package/@opentelemetry/sdk-node`) for the most seamless instrumentation experience.
99

10-
Compatible with OpenTelemetry JS API and SDK `1.0+`.
10+
## Status
11+
12+
| Maturity | [Component Owner](../../../.github/component_owners.yml) | Compatibility |
13+
| ----------------------------------------------------- | -------------------------------------------------------- | --------------------- |
14+
| [Unmaintained](../../../CONTRIBUTING.md#unmaintained) | N/A | API 1.0+<br/>SDK 1.0+ |
1115

1216
## Installation
1317

@@ -45,10 +49,10 @@ Note that generator-based middleware are deprecated and won't be instrumented.
4549

4650
### Koa Instrumentation Options
4751

48-
| Options | Type | Example | Description |
49-
| ------- | ---- | ------- | ----------- |
50-
| `ignoreLayersType`| `KoaLayerType[]` | `['middleware']` | Ignore layers of specified type. |
51-
| `requestHook` | `KoaRequestCustomAttributeFunction` | `(span, info) => {}` | Function for adding custom attributes to Koa middleware layers. Receives params: `Span, KoaRequestInfo`. |
52+
| Options | Type | Example | Description |
53+
| ------------------ | ----------------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------- |
54+
| `ignoreLayersType` | `KoaLayerType[]` | `['middleware']` | Ignore layers of specified type. |
55+
| `requestHook` | `KoaRequestCustomAttributeFunction` | `(span, info) => {}` | Function for adding custom attributes to Koa middleware layers. Receives params: `Span, KoaRequestInfo`. |
5256

5357
`ignoreLayersType` accepts an array of `KoaLayerType` which can take the following string values:
5458

0 commit comments

Comments
 (0)