@davidilie/telemetry-node 0.0.0-bootstrap.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +224 -0
- package/THIRD_PARTY_NOTICES.md +11 -0
- package/UPSTREAM.yml +56 -0
- package/dist/client-BzoFCwmQ.d.cts +85 -0
- package/dist/client-BzoFCwmQ.d.mts +85 -0
- package/dist/index.cjs +15 -0
- package/dist/index.d.cts +34 -0
- package/dist/index.d.mts +34 -0
- package/dist/index.mjs +2 -0
- package/dist/register.cjs +53 -0
- package/dist/register.d.cts +10 -0
- package/dist/register.d.mts +10 -0
- package/dist/register.mjs +51 -0
- package/dist/sampler-BnXptsJ8.cjs +513 -0
- package/dist/sampler-fxBt_DLP.mjs +436 -0
- package/package.json +85 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,224 @@
|
|
|
1
|
+
# `@davidilie/telemetry-node`
|
|
2
|
+
|
|
3
|
+
OpenTelemetry-backed events, logs, measurements, exceptions, and spans for
|
|
4
|
+
Node.js. Use the `/register` entrypoint in a standalone process. Use the root
|
|
5
|
+
entrypoint when a framework already owns the OpenTelemetry provider.
|
|
6
|
+
|
|
7
|
+
Node.js 20 or newer is supported. The package publishes ESM and CommonJS.
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
pnpm add @davidilie/telemetry-node @opentelemetry/api
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Standalone Node.js
|
|
14
|
+
|
|
15
|
+
Import registration before modules that need to be auto-instrumented.
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
import { registerNodeTelemetry } from "@davidilie/telemetry-node/register";
|
|
19
|
+
|
|
20
|
+
const deployedSha = process.env.GIT_SHA!;
|
|
21
|
+
const telemetry = registerNodeTelemetry({
|
|
22
|
+
resource: {
|
|
23
|
+
serviceName: "email-worker",
|
|
24
|
+
serviceVersion: deployedSha,
|
|
25
|
+
environment: process.env.DEPLOYMENT_ENV ?? "production",
|
|
26
|
+
namespace: "notifications",
|
|
27
|
+
repositoryUrl: "https://github.com/example/email-worker",
|
|
28
|
+
commitSha: deployedSha,
|
|
29
|
+
attributes: {
|
|
30
|
+
"davidapps.project.id": "notifications",
|
|
31
|
+
},
|
|
32
|
+
},
|
|
33
|
+
});
|
|
34
|
+
|
|
35
|
+
await telemetry.withSpan(
|
|
36
|
+
"jobs.process",
|
|
37
|
+
async () => {
|
|
38
|
+
telemetry.capture("job.started", { "messaging.destination.name": "email" });
|
|
39
|
+
},
|
|
40
|
+
{ "job.type": "email" },
|
|
41
|
+
);
|
|
42
|
+
|
|
43
|
+
process.once("SIGTERM", async () => {
|
|
44
|
+
await telemetry.shutdown();
|
|
45
|
+
process.exit(0);
|
|
46
|
+
});
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
`registerNodeTelemetry` installs one `NodeSDK` per JavaScript global. Repeated
|
|
50
|
+
calls return the first client and ignore later configuration until that client
|
|
51
|
+
successfully shuts down. Do not register this package beside another provider.
|
|
52
|
+
|
|
53
|
+
The optional `sdk` property accepts `NodeSDKConfiguration` fields other than
|
|
54
|
+
`resource` and `serviceName`. Use it for maintained instrumentations, readers,
|
|
55
|
+
processors, or exporters when environment-based defaults are insufficient.
|
|
56
|
+
|
|
57
|
+
## Export configuration
|
|
58
|
+
|
|
59
|
+
The standalone SDK follows standard OpenTelemetry environment variables. For
|
|
60
|
+
Alloy's private OTLP/HTTP receiver:
|
|
61
|
+
|
|
62
|
+
```sh
|
|
63
|
+
OTEL_SERVICE_NAME=email-worker
|
|
64
|
+
OTEL_EXPORTER_OTLP_ENDPOINT=http://alloy.observability.svc.cluster.local:4318
|
|
65
|
+
OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Set `OTEL_TRACES_EXPORTER=none`, `OTEL_LOGS_EXPORTER=none`, or
|
|
69
|
+
`OTEL_METRICS_EXPORTER=none` to disable a signal. Configure resource data in the
|
|
70
|
+
JavaScript `resource` object above; it remains the package's canonical mapping.
|
|
71
|
+
|
|
72
|
+
Server workloads should use private Alloy directly. Do not put the public
|
|
73
|
+
browser/mobile routing key on a server unless the workload genuinely runs
|
|
74
|
+
outside the cluster and the gateway has intentionally enabled that signal.
|
|
75
|
+
|
|
76
|
+
## Existing provider
|
|
77
|
+
|
|
78
|
+
Frameworks such as Next.js may already own provider registration. Create only
|
|
79
|
+
the client from the runtime-light root entrypoint:
|
|
80
|
+
|
|
81
|
+
```ts
|
|
82
|
+
import { createNodeTelemetry } from "@davidilie/telemetry-node";
|
|
83
|
+
|
|
84
|
+
const telemetry = createNodeTelemetry({
|
|
85
|
+
resource: {
|
|
86
|
+
serviceName: "web",
|
|
87
|
+
serviceVersion: process.env.GIT_SHA,
|
|
88
|
+
environment: process.env.DEPLOYMENT_ENV,
|
|
89
|
+
commitSha: process.env.GIT_SHA,
|
|
90
|
+
attributes: { "davidapps.project.id": "web" },
|
|
91
|
+
},
|
|
92
|
+
});
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
Without a registered provider, trace and metric API calls are no-ops. The
|
|
96
|
+
structured-console log path still works.
|
|
97
|
+
|
|
98
|
+
## Client configuration
|
|
99
|
+
|
|
100
|
+
| Option | Behavior |
|
|
101
|
+
| --- | --- |
|
|
102
|
+
| `resource` | Required shared service/project/exact-release identity |
|
|
103
|
+
| `enabled` / `consent` | Gate future client-created signals; pending/denied do not queue |
|
|
104
|
+
| `sampleRate` | `0..1`; standalone registration applies it once to root traces and logs, while metrics remain aggregated rather than randomly sampled |
|
|
105
|
+
| `beforeSend` | Async transform/drop hook with a second sanitization pass |
|
|
106
|
+
| `debug` / `onError` | Contained telemetry diagnostics |
|
|
107
|
+
| `instrumentationName` / `instrumentationVersion` | OTel tracer/logger/meter library identity; not application release identity |
|
|
108
|
+
| `structuredConsole` | JSON stdout/stderr fallback, default `true` |
|
|
109
|
+
| `measurementMode` | `spans`, `metrics`, or `both` |
|
|
110
|
+
| `metricAttributeAllowlist` | Bounded signal keys allowed on metric points |
|
|
111
|
+
| `maxMetricInstruments` | Maximum histogram name/unit pairs, default 64 |
|
|
112
|
+
| `sdk` | `/register` only: provider configuration excluding resource/service name |
|
|
113
|
+
|
|
114
|
+
Do not put the deployed commit into `instrumentationVersion`; it belongs in
|
|
115
|
+
resource `serviceVersion`/`commitSha`. The instrumentation version identifies
|
|
116
|
+
the instrumentation library itself.
|
|
117
|
+
|
|
118
|
+
## Signal mapping
|
|
119
|
+
|
|
120
|
+
| Core call | Node behavior |
|
|
121
|
+
| --- | --- |
|
|
122
|
+
| `capture(name, attrs)` | Adds an event to the active span; otherwise creates and ends a short internal span containing the event |
|
|
123
|
+
| `captureException(error, attrs)` | Records on the active span and marks it error; otherwise creates an `exception` span |
|
|
124
|
+
| `log(level, message, attrs)` | Emits through the OTel Logs API and, by default, one JSON line to stdout/stderr |
|
|
125
|
+
| `measure(name, value, attrs, unit)` | By default records a short `measurement:<name>` trace span; can instead/additionally record an OTel histogram |
|
|
126
|
+
| `withSpan(name, operation, attrs, options)` | Creates an active span with an optional portable kind, records/rethrows application failures, and always ends it |
|
|
127
|
+
|
|
128
|
+
Measurements default to spans so they remain observable without an OTel metric
|
|
129
|
+
reader. Configure the representation explicitly when needed:
|
|
130
|
+
|
|
131
|
+
```ts
|
|
132
|
+
const telemetry = registerNodeTelemetry({
|
|
133
|
+
resource,
|
|
134
|
+
measurementMode: "both", // "spans" (default), "metrics", or "both"
|
|
135
|
+
metricAttributeAllowlist: ["checkout.provider"],
|
|
136
|
+
maxMetricInstruments: 32,
|
|
137
|
+
sdk: {
|
|
138
|
+
metricReaders: [reader],
|
|
139
|
+
},
|
|
140
|
+
});
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
When `/register` sees configured `sdk.metricReaders`, its default mode becomes
|
|
144
|
+
`metrics`; otherwise it is `spans`. A framework client chooses the mode supplied
|
|
145
|
+
by the caller. Histogram names must match the adapter's bounded instrument-name
|
|
146
|
+
syntax, and no more than 64 name/unit pairs are created by default. Only
|
|
147
|
+
explicitly allowlisted signal attributes reach metric points; resource labels
|
|
148
|
+
come from the provider. Metrics still require a reader/exporter.
|
|
149
|
+
|
|
150
|
+
### Structured logs and correlation
|
|
151
|
+
|
|
152
|
+
JSON console output is enabled by default so Kubernetes log collection reaches
|
|
153
|
+
VictoriaLogs even when the framework provider did not configure OTel Logs. It
|
|
154
|
+
includes `service_name`, `service_version`, and active `trace_id`/`span_id`.
|
|
155
|
+
|
|
156
|
+
```ts
|
|
157
|
+
const telemetry = createNodeTelemetry({
|
|
158
|
+
resource,
|
|
159
|
+
structuredConsole: false, // OTel Logs is the sole desired route.
|
|
160
|
+
});
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
The default can duplicate a logical log if both stdout and OTLP Logs are
|
|
164
|
+
collected into the same backend. Disable one route deliberately.
|
|
165
|
+
|
|
166
|
+
## Spans and context
|
|
167
|
+
|
|
168
|
+
The `NodeTelemetryClient` overrides the generic core `withSpan` so the new span
|
|
169
|
+
is active during the operation. Use it when events/logs need the same trace.
|
|
170
|
+
`client.startSpan()` creates a span but does not make it active.
|
|
171
|
+
|
|
172
|
+
Both methods accept `{ kind: "internal" | "server" | "client" | "producer" |
|
|
173
|
+
"consumer" }` after attributes. Manual span handles also expose
|
|
174
|
+
`setStatus("unset" | "ok" | "error", message?)`.
|
|
175
|
+
|
|
176
|
+
The package also exports provider-level helpers:
|
|
177
|
+
|
|
178
|
+
```ts
|
|
179
|
+
import {
|
|
180
|
+
currentTraceContext,
|
|
181
|
+
recordException,
|
|
182
|
+
startSpan,
|
|
183
|
+
withSpan,
|
|
184
|
+
} from "@davidilie/telemetry-node";
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
These use the globally registered provider and do not add a client's resource
|
|
188
|
+
mapping, context, or `beforeSend`. They sanitize their direct names,
|
|
189
|
+
attributes, exceptions, and status text, but do not consult a root client's
|
|
190
|
+
per-call consent/sampling; only the globally registered provider's policy can
|
|
191
|
+
gate them. Use the initialized client for application signals and reserve these
|
|
192
|
+
helpers for reviewed provider integrations. `withSpan` establishes active
|
|
193
|
+
context; `startSpan` does not.
|
|
194
|
+
|
|
195
|
+
## Failure, consent, and lifecycle behavior
|
|
196
|
+
|
|
197
|
+
- Core capture calls isolate hook/export errors from the application.
|
|
198
|
+
- `withSpan` rethrows the application's failure after recording it.
|
|
199
|
+
- `enabled: false`, pending consent, and denied consent skip new client calls;
|
|
200
|
+
they do not buffer for later.
|
|
201
|
+
- Standalone registration wraps a parent-based trace-ratio sampler in a mutable
|
|
202
|
+
collection gate. `setEnabled` and `setConsent` update that provider-wide gate
|
|
203
|
+
immediately, including for automatic instrumentation and sampled-parent
|
|
204
|
+
spans. A custom `sdk.sampler` replaces the ratio sampler but remains inside
|
|
205
|
+
the gate.
|
|
206
|
+
- The standalone client does not sample traces twice: the provider owns span,
|
|
207
|
+
event, and exception trace decisions, while the adapter applies `sampleRate`
|
|
208
|
+
once to logs. OTel histogram measurements are aggregated without random
|
|
209
|
+
point sampling. A root-entrypoint client has no provider ownership, so its
|
|
210
|
+
core per-call gate and an externally configured provider sampler can both
|
|
211
|
+
apply; set one layer to `1` if multiplied rates are not intentional.
|
|
212
|
+
- State changes affect new work and do not erase an already exported or queued
|
|
213
|
+
provider batch.
|
|
214
|
+
- `flush()` drains core work, but the Node adapter does not own a provider
|
|
215
|
+
force-flush method. `shutdown()` on the `/register` client shuts down the
|
|
216
|
+
`NodeSDK` and its processors.
|
|
217
|
+
- Only a client returned by `/register` owns and shuts down the installed
|
|
218
|
+
`NodeSDK`. A client created from the root entrypoint does not own the
|
|
219
|
+
framework provider.
|
|
220
|
+
- `onError(error, context)` receives contained hook/adapter/span/lifecycle
|
|
221
|
+
failures. Its own failure is ignored; never recurse into the same client.
|
|
222
|
+
|
|
223
|
+
See the [core API](https://www.npmjs.com/package/@davidilie/telemetry-core), [privacy rules](https://github.com/DavidIlie/davidapps-telemetry/blob/main/docs/privacy.md), and
|
|
224
|
+
[troubleshooting guide](https://github.com/DavidIlie/davidapps-telemetry/blob/main/docs/troubleshooting.md).
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Third-party notices
|
|
2
|
+
|
|
3
|
+
DavidApps Telemetry depends on permissively licensed open-source projects and used other SDKs as API and implementation references. Exact source commits and usage classifications are tracked in `UPSTREAM.yml`.
|
|
4
|
+
|
|
5
|
+
- Grafana Faro Web SDK — Apache License 2.0 — Copyright Grafana Labs.
|
|
6
|
+
- OpenTelemetry JS API 1.9.0/1.9.1, stable SDK 2.10.0, and experimental SDK 0.221.0 — Apache License 2.0 — Copyright The OpenTelemetry Authors.
|
|
7
|
+
- Vercel Analytics and Vercel OTEL — MIT License — Copyright Vercel, Inc.
|
|
8
|
+
- PostHog JavaScript SDKs — Apache-2.0/MIT — API reference only; no source is vendored.
|
|
9
|
+
- Honeycomb OpenTelemetry React Native — MIT License — Copyright Honeycomb.io.
|
|
10
|
+
|
|
11
|
+
Reference license texts are retained in `licenses/` so future adaptations cannot accidentally lose their attribution obligations. The current source tree does not vendor code from PostHog, Vercel, Honeycomb, or the OpenTelemetry demo.
|
package/UPSTREAM.yml
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
version: 1
|
|
2
|
+
sources:
|
|
3
|
+
- name: grafana-faro-web-sdk
|
|
4
|
+
repository: https://github.com/grafana/faro-web-sdk
|
|
5
|
+
license: Apache-2.0
|
|
6
|
+
commit: fafe843c8b21efe98a64250a11b48828604381fb
|
|
7
|
+
use: dependency
|
|
8
|
+
- name: vercel-otel
|
|
9
|
+
repository: https://github.com/vercel/otel
|
|
10
|
+
license: MIT
|
|
11
|
+
commit: 4745daa7559cd41d2fceedeadb56aeec7724735a
|
|
12
|
+
use: dependency
|
|
13
|
+
- name: vercel-analytics
|
|
14
|
+
repository: https://github.com/vercel/analytics
|
|
15
|
+
license: MIT
|
|
16
|
+
commit: d5df714080cbfdc7ee5e84b9aa6918e291a8e979
|
|
17
|
+
use: api-reference
|
|
18
|
+
- name: posthog-js
|
|
19
|
+
repository: https://github.com/PostHog/posthog-js
|
|
20
|
+
license: mixed-apache-2.0-and-mit
|
|
21
|
+
commit: 9a58462065dbe612ee4f6728d28c6275358643ad
|
|
22
|
+
use: api-reference
|
|
23
|
+
- name: opentelemetry-js-stable-2.10.0
|
|
24
|
+
repository: https://github.com/open-telemetry/opentelemetry-js
|
|
25
|
+
license: Apache-2.0
|
|
26
|
+
release: v2.10.0
|
|
27
|
+
commit: 76fa6b509e2b48d9cbee31cb37a2efc61dc4d384
|
|
28
|
+
use: dependency
|
|
29
|
+
- name: opentelemetry-js-experimental-0.221.0
|
|
30
|
+
repository: https://github.com/open-telemetry/opentelemetry-js
|
|
31
|
+
license: Apache-2.0
|
|
32
|
+
release: experimental/v0.221.0
|
|
33
|
+
commit: 76fa6b509e2b48d9cbee31cb37a2efc61dc4d384
|
|
34
|
+
use: dependency
|
|
35
|
+
- name: opentelemetry-js-api-1.9.0
|
|
36
|
+
repository: https://github.com/open-telemetry/opentelemetry-js
|
|
37
|
+
license: Apache-2.0
|
|
38
|
+
release: v1.9.0
|
|
39
|
+
commit: 08f597f3a3d71a4852b0afbba120af15ca038121
|
|
40
|
+
use: dependency
|
|
41
|
+
- name: opentelemetry-js-api-1.9.1
|
|
42
|
+
repository: https://github.com/open-telemetry/opentelemetry-js
|
|
43
|
+
license: Apache-2.0
|
|
44
|
+
release: v1.9.1
|
|
45
|
+
commit: 279458e7ddf16f7ddca5fe60c78672e05fafce66
|
|
46
|
+
use: dependency
|
|
47
|
+
- name: opentelemetry-demo-react-native
|
|
48
|
+
repository: https://github.com/open-telemetry/opentelemetry-demo
|
|
49
|
+
license: Apache-2.0
|
|
50
|
+
commit: 2e05c45b85b985a691cc75082c234e8d6ac0b2e9
|
|
51
|
+
use: api-reference
|
|
52
|
+
- name: honeycomb-opentelemetry-react-native
|
|
53
|
+
repository: https://github.com/honeycombio/honeycomb-opentelemetry-react-native
|
|
54
|
+
license: MIT
|
|
55
|
+
commit: 07d144459177a58a347e18be762cf8f04e63cb1d
|
|
56
|
+
use: api-reference
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
import { Span } from "@opentelemetry/api";
|
|
2
|
+
import { AttributeValue as AttributeValue$1, Attributes as Attributes$1, BeforeSend, TelemetryAdapter, TelemetryClient, TelemetryErrorHandler, TelemetryResource, TelemetrySignal, TelemetrySpan, TelemetrySpanOptions, TelemetrySpanStatus, TraceContext } from "@davidilie/telemetry-core";
|
|
3
|
+
//#region src/adapter.d.ts
|
|
4
|
+
type MeasurementMode = "metrics" | "spans" | "both";
|
|
5
|
+
declare class OpenTelemetrySpan implements TelemetrySpan {
|
|
6
|
+
#private;
|
|
7
|
+
constructor(span: Span);
|
|
8
|
+
setAttribute(name: string, value: AttributeValue$1): this;
|
|
9
|
+
recordException(error: unknown, attributes?: Attributes$1): void;
|
|
10
|
+
setStatus(status: TelemetrySpanStatus, message?: string): this;
|
|
11
|
+
end(): void;
|
|
12
|
+
}
|
|
13
|
+
interface OpenTelemetryAdapterConfig {
|
|
14
|
+
resource: TelemetryResource;
|
|
15
|
+
instrumentationName?: string;
|
|
16
|
+
instrumentationVersion?: string;
|
|
17
|
+
structuredConsole?: boolean;
|
|
18
|
+
/** How `measure()` is represented. Defaults to trace spans. */
|
|
19
|
+
measurementMode?: MeasurementMode;
|
|
20
|
+
/** Explicit low-cardinality signal attributes allowed onto metric points. */
|
|
21
|
+
metricAttributeAllowlist?: readonly string[];
|
|
22
|
+
/** Bound on distinct histogram name/unit pairs. Defaults to 64. */
|
|
23
|
+
maxMetricInstruments?: number;
|
|
24
|
+
/** Internal: provider-managed trace sampling still needs a log decision. */
|
|
25
|
+
logSampleRate?: number;
|
|
26
|
+
shutdown?: () => void | Promise<void>;
|
|
27
|
+
}
|
|
28
|
+
declare class OpenTelemetryAdapter implements TelemetryAdapter {
|
|
29
|
+
#private;
|
|
30
|
+
constructor(config: OpenTelemetryAdapterConfig);
|
|
31
|
+
send(signal: TelemetrySignal): void;
|
|
32
|
+
startSpan(name: string, attributes?: Attributes$1, options?: TelemetrySpanOptions): TelemetrySpan;
|
|
33
|
+
currentTraceContext(): TraceContext | undefined;
|
|
34
|
+
withActiveSpan<T>(name: string, operation: () => T | Promise<T>, attributes?: Attributes$1, options?: TelemetrySpanOptions): Promise<T>;
|
|
35
|
+
shutdown(): Promise<void>;
|
|
36
|
+
}
|
|
37
|
+
declare function createOpenTelemetryAdapter(config: OpenTelemetryAdapterConfig): OpenTelemetryAdapter;
|
|
38
|
+
declare function currentTraceContext(): TraceContext | undefined;
|
|
39
|
+
declare function startSpan(name: string, attributes?: Attributes$1, options?: TelemetrySpanOptions): TelemetrySpan;
|
|
40
|
+
declare function withSpan<T>(name: string, operation: () => T | Promise<T>, attributes?: Attributes$1, options?: TelemetrySpanOptions): Promise<T>;
|
|
41
|
+
declare function recordException(error: unknown, attributes?: Attributes$1): void;
|
|
42
|
+
//#endregion
|
|
43
|
+
//#region src/client.d.ts
|
|
44
|
+
interface NodeTelemetryConfig {
|
|
45
|
+
resource: TelemetryResource;
|
|
46
|
+
beforeSend?: BeforeSend;
|
|
47
|
+
enabled?: boolean;
|
|
48
|
+
sampleRate?: number;
|
|
49
|
+
consent?: "granted" | "denied" | "pending";
|
|
50
|
+
debug?: boolean;
|
|
51
|
+
instrumentationName?: string;
|
|
52
|
+
instrumentationVersion?: string;
|
|
53
|
+
/**
|
|
54
|
+
* Write JSON logs to stdout/stderr for Kubernetes log collection. Defaults
|
|
55
|
+
* to true. Set false when OTLP logs are the sole desired path.
|
|
56
|
+
*/
|
|
57
|
+
structuredConsole?: boolean;
|
|
58
|
+
/** Export measurements as trace spans, OTEL metrics, or both. */
|
|
59
|
+
measurementMode?: OpenTelemetryAdapterConfig["measurementMode"];
|
|
60
|
+
/** Low-cardinality application attributes permitted on metric points. */
|
|
61
|
+
metricAttributeAllowlist?: readonly string[];
|
|
62
|
+
/** Maximum distinct histogram name/unit pairs created by this client. */
|
|
63
|
+
maxMetricInstruments?: number;
|
|
64
|
+
/** Receives telemetry failures; handler failures are also contained. */
|
|
65
|
+
onError?: TelemetryErrorHandler;
|
|
66
|
+
}
|
|
67
|
+
interface NodeTelemetryInternalConfig extends NodeTelemetryConfig {
|
|
68
|
+
shutdown?: OpenTelemetryAdapterConfig["shutdown"];
|
|
69
|
+
/** Provider registration owns trace sampling; avoid sampling spans twice. */
|
|
70
|
+
providerManagedSampling?: boolean;
|
|
71
|
+
onCollectionStateChange?: (state: {
|
|
72
|
+
enabled: boolean;
|
|
73
|
+
consent: "granted" | "denied" | "pending";
|
|
74
|
+
}) => void;
|
|
75
|
+
}
|
|
76
|
+
declare class NodeTelemetryClient extends TelemetryClient {
|
|
77
|
+
#private;
|
|
78
|
+
constructor(config: NodeTelemetryInternalConfig);
|
|
79
|
+
setEnabled(enabled: boolean): void;
|
|
80
|
+
setConsent(consent: "granted" | "denied" | "pending"): void;
|
|
81
|
+
withSpan<T>(name: string, operation: () => T | Promise<T>, attributes?: Attributes$1, options?: TelemetrySpanOptions): Promise<T>;
|
|
82
|
+
}
|
|
83
|
+
declare function createNodeTelemetry(config: NodeTelemetryConfig): NodeTelemetryClient;
|
|
84
|
+
//#endregion
|
|
85
|
+
export { OpenTelemetryAdapter as a, createOpenTelemetryAdapter as c, startSpan as d, withSpan as f, MeasurementMode as i, currentTraceContext as l, NodeTelemetryConfig as n, OpenTelemetryAdapterConfig as o, createNodeTelemetry as r, OpenTelemetrySpan as s, NodeTelemetryClient as t, recordException as u };
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
import { Span } from "@opentelemetry/api";
|
|
2
|
+
import { AttributeValue as AttributeValue$1, Attributes as Attributes$1, BeforeSend, TelemetryAdapter, TelemetryClient, TelemetryErrorHandler, TelemetryResource, TelemetrySignal, TelemetrySpan, TelemetrySpanOptions, TelemetrySpanStatus, TraceContext } from "@davidilie/telemetry-core";
|
|
3
|
+
//#region src/adapter.d.ts
|
|
4
|
+
type MeasurementMode = "metrics" | "spans" | "both";
|
|
5
|
+
declare class OpenTelemetrySpan implements TelemetrySpan {
|
|
6
|
+
#private;
|
|
7
|
+
constructor(span: Span);
|
|
8
|
+
setAttribute(name: string, value: AttributeValue$1): this;
|
|
9
|
+
recordException(error: unknown, attributes?: Attributes$1): void;
|
|
10
|
+
setStatus(status: TelemetrySpanStatus, message?: string): this;
|
|
11
|
+
end(): void;
|
|
12
|
+
}
|
|
13
|
+
interface OpenTelemetryAdapterConfig {
|
|
14
|
+
resource: TelemetryResource;
|
|
15
|
+
instrumentationName?: string;
|
|
16
|
+
instrumentationVersion?: string;
|
|
17
|
+
structuredConsole?: boolean;
|
|
18
|
+
/** How `measure()` is represented. Defaults to trace spans. */
|
|
19
|
+
measurementMode?: MeasurementMode;
|
|
20
|
+
/** Explicit low-cardinality signal attributes allowed onto metric points. */
|
|
21
|
+
metricAttributeAllowlist?: readonly string[];
|
|
22
|
+
/** Bound on distinct histogram name/unit pairs. Defaults to 64. */
|
|
23
|
+
maxMetricInstruments?: number;
|
|
24
|
+
/** Internal: provider-managed trace sampling still needs a log decision. */
|
|
25
|
+
logSampleRate?: number;
|
|
26
|
+
shutdown?: () => void | Promise<void>;
|
|
27
|
+
}
|
|
28
|
+
declare class OpenTelemetryAdapter implements TelemetryAdapter {
|
|
29
|
+
#private;
|
|
30
|
+
constructor(config: OpenTelemetryAdapterConfig);
|
|
31
|
+
send(signal: TelemetrySignal): void;
|
|
32
|
+
startSpan(name: string, attributes?: Attributes$1, options?: TelemetrySpanOptions): TelemetrySpan;
|
|
33
|
+
currentTraceContext(): TraceContext | undefined;
|
|
34
|
+
withActiveSpan<T>(name: string, operation: () => T | Promise<T>, attributes?: Attributes$1, options?: TelemetrySpanOptions): Promise<T>;
|
|
35
|
+
shutdown(): Promise<void>;
|
|
36
|
+
}
|
|
37
|
+
declare function createOpenTelemetryAdapter(config: OpenTelemetryAdapterConfig): OpenTelemetryAdapter;
|
|
38
|
+
declare function currentTraceContext(): TraceContext | undefined;
|
|
39
|
+
declare function startSpan(name: string, attributes?: Attributes$1, options?: TelemetrySpanOptions): TelemetrySpan;
|
|
40
|
+
declare function withSpan<T>(name: string, operation: () => T | Promise<T>, attributes?: Attributes$1, options?: TelemetrySpanOptions): Promise<T>;
|
|
41
|
+
declare function recordException(error: unknown, attributes?: Attributes$1): void;
|
|
42
|
+
//#endregion
|
|
43
|
+
//#region src/client.d.ts
|
|
44
|
+
interface NodeTelemetryConfig {
|
|
45
|
+
resource: TelemetryResource;
|
|
46
|
+
beforeSend?: BeforeSend;
|
|
47
|
+
enabled?: boolean;
|
|
48
|
+
sampleRate?: number;
|
|
49
|
+
consent?: "granted" | "denied" | "pending";
|
|
50
|
+
debug?: boolean;
|
|
51
|
+
instrumentationName?: string;
|
|
52
|
+
instrumentationVersion?: string;
|
|
53
|
+
/**
|
|
54
|
+
* Write JSON logs to stdout/stderr for Kubernetes log collection. Defaults
|
|
55
|
+
* to true. Set false when OTLP logs are the sole desired path.
|
|
56
|
+
*/
|
|
57
|
+
structuredConsole?: boolean;
|
|
58
|
+
/** Export measurements as trace spans, OTEL metrics, or both. */
|
|
59
|
+
measurementMode?: OpenTelemetryAdapterConfig["measurementMode"];
|
|
60
|
+
/** Low-cardinality application attributes permitted on metric points. */
|
|
61
|
+
metricAttributeAllowlist?: readonly string[];
|
|
62
|
+
/** Maximum distinct histogram name/unit pairs created by this client. */
|
|
63
|
+
maxMetricInstruments?: number;
|
|
64
|
+
/** Receives telemetry failures; handler failures are also contained. */
|
|
65
|
+
onError?: TelemetryErrorHandler;
|
|
66
|
+
}
|
|
67
|
+
interface NodeTelemetryInternalConfig extends NodeTelemetryConfig {
|
|
68
|
+
shutdown?: OpenTelemetryAdapterConfig["shutdown"];
|
|
69
|
+
/** Provider registration owns trace sampling; avoid sampling spans twice. */
|
|
70
|
+
providerManagedSampling?: boolean;
|
|
71
|
+
onCollectionStateChange?: (state: {
|
|
72
|
+
enabled: boolean;
|
|
73
|
+
consent: "granted" | "denied" | "pending";
|
|
74
|
+
}) => void;
|
|
75
|
+
}
|
|
76
|
+
declare class NodeTelemetryClient extends TelemetryClient {
|
|
77
|
+
#private;
|
|
78
|
+
constructor(config: NodeTelemetryInternalConfig);
|
|
79
|
+
setEnabled(enabled: boolean): void;
|
|
80
|
+
setConsent(consent: "granted" | "denied" | "pending"): void;
|
|
81
|
+
withSpan<T>(name: string, operation: () => T | Promise<T>, attributes?: Attributes$1, options?: TelemetrySpanOptions): Promise<T>;
|
|
82
|
+
}
|
|
83
|
+
declare function createNodeTelemetry(config: NodeTelemetryConfig): NodeTelemetryClient;
|
|
84
|
+
//#endregion
|
|
85
|
+
export { OpenTelemetryAdapter as a, createOpenTelemetryAdapter as c, startSpan as d, withSpan as f, MeasurementMode as i, currentTraceContext as l, NodeTelemetryConfig as n, OpenTelemetryAdapterConfig as o, createNodeTelemetry as r, OpenTelemetrySpan as s, NodeTelemetryClient as t, recordException as u };
|