@dash0/serverless-dash0 1.0.0 → 1.0.2

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.
Files changed (5) hide show
  1. package/README.md +8 -4
  2. package/dist/config-validator.d.ts +2 -0
  3. package/dist/env-injector.js +2 -0
  4. package/dist/versions.json +3 -3
  5. package/package.json +9 -2
package/README.md CHANGED
@@ -7,20 +7,22 @@ Compatible with Serverless Framework v3 and v4.
7
7
  ## Installation
8
8
 
9
9
  ```bash
10
- npm install --save-dev serverless-dash0
10
+ npm install --save-dev @dash0/serverless-dash0
11
11
  ```
12
12
 
13
13
  ## Usage
14
14
 
15
15
  Add the plugin to your `serverless.yml` and configure the `custom.dash0` section:
16
16
 
17
+ > **Where to find your endpoint:** In the Dash0 app, go to **Settings → Endpoints → OTLP via HTTP** and copy the value from the **Endpoint** field.
18
+
17
19
  ```yaml
18
20
  plugins:
19
- - serverless-dash0
21
+ - "@dash0/serverless-dash0"
20
22
 
21
23
  custom:
22
24
  dash0:
23
- endpoint: https://ingress.eu-west-1.aws.dash0.com:4318
25
+ endpoint: https://ingress.<your-environment>.dash0.com:4318 # e.g. https://ingress.eu-west-1.aws.dash0.com:4318
24
26
  token: ${env:DASH0_TOKEN}
25
27
  layerVersion: latest
26
28
 
@@ -55,7 +57,7 @@ All options are set under `custom.dash0` in your `serverless.yml`.
55
57
 
56
58
  | Option | Type | Description |
57
59
  | --- | --- | --- |
58
- | `endpoint` | `string` | Dash0 OTLP ingestion endpoint. |
60
+ | `endpoint` | `string` | Dash0 OTLP ingestion endpoint. Find it in the Dash0 app under **Settings → Endpoints → OTLP via HTTP → Endpoint**. |
59
61
  | `layerVersion` | `number` or `"latest"` | Layer version to use. A specific version number, or `"latest"` to use the version bundled with the plugin. |
60
62
  | `token` | `string` | Dash0 API token. Required unless `tokenSecretArn` is provided. |
61
63
  | `tokenSecretArn` | `string` | ARN of an AWS Secrets Manager secret containing the Dash0 API token. Required unless `token` is provided. If both are set, both environment variables will be added. |
@@ -70,6 +72,8 @@ All options are set under `custom.dash0` in your `serverless.yml`.
70
72
  | `disableAutoInstrumentation` | `boolean` | `false` | `DASH0_DISABLE_AUTO_INSTRUMENTATION` | Disable auto-instrumentation. The extension will still create synthetic spans. |
71
73
  | `sendOnInvocationEnd` | `boolean` | `true` | `DASH0_SEND_ON_INVOCATION_END` | Send telemetry at the end of the current invocation instead of the beginning of the next. |
72
74
  | `disableTelemetryLogCollection` | `boolean` | `false` | `DASH0_DISABLE_TELEMETRY_LOG_COLLECTION` | Disable Lambda Telemetry API log collection. |
75
+ | `disableTelemetryMetrics` | `boolean` | `false` | `DASH0_DISABLE_TELEMETRY_METRICS` | Disable emission of supplementary FaaS metrics. |
76
+ | `disableTelemetryTraces` | `boolean` | `false` | `DASH0_DISABLE_TELEMETRY_TRACES` | Disable both auto-instrumentation and synthetic spans (including error-path traces). |
73
77
  | `createPayloadLogRecords` | `boolean` | `true` | `DASH0_CREATE_PAYLOAD_LOG_RECORDS` | Create log records for request/response payloads. |
74
78
  | `requestTimeout` | `number` | `2000` | `DASH0_REQUEST_TIMEOUT` | HTTP request timeout in milliseconds. |
75
79
  | `xrayTracesEnabled` | `boolean` | `false` | `DASH0_XRAY_TRACES_ENABLED` | Preserve X-Ray trace context. |
package/dist/config-validator.d.ts CHANGED
@@ -11,6 +11,8 @@ export interface Dash0Config {
11
11
  disableAutoInstrumentation?: boolean | string;
12
12
  sendOnInvocationEnd?: boolean | string;
13
13
  disableTelemetryLogCollection?: boolean | string;
14
+ disableTelemetryMetrics?: boolean | string;
15
+ disableTelemetryTraces?: boolean | string;
14
16
  createPayloadLogRecords?: boolean | string;
15
17
  requestTimeout?: number;
16
18
  xrayTracesEnabled?: boolean | string;
package/dist/env-injector.js CHANGED
@@ -7,6 +7,8 @@ const OPTIONAL_MAPPINGS = {
7
7
  disableAutoInstrumentation: 'DASH0_DISABLE_AUTO_INSTRUMENTATION',
8
8
  sendOnInvocationEnd: 'DASH0_SEND_ON_INVOCATION_END',
9
9
  disableTelemetryLogCollection: 'DASH0_DISABLE_TELEMETRY_LOG_COLLECTION',
10
+ disableTelemetryMetrics: 'DASH0_DISABLE_TELEMETRY_METRICS',
11
+ disableTelemetryTraces: 'DASH0_DISABLE_TELEMETRY_TRACES',
10
12
  createPayloadLogRecords: 'DASH0_CREATE_PAYLOAD_LOG_RECORDS',
11
13
  requestTimeout: 'DASH0_REQUEST_TIMEOUT',
12
14
  xrayTracesEnabled: 'DASH0_XRAY_TRACES_ENABLED',
package/dist/versions.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "dash0-extension-node": 5,
3
- "dash0-extension-python": 5,
4
- "dash0-extension-java": 5
2
+ "dash0-extension-node": 20,
3
+ "dash0-extension-python": 20,
4
+ "dash0-extension-java": 20
5
5
  }
package/package.json CHANGED
@@ -1,7 +1,11 @@
1
1
  {
2
2
  "name": "@dash0/serverless-dash0",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "Serverless Framework plugin to automatically add Dash0 Lambda tracing layers and configuration",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "git+https://github.com/dash0hq/dash0-lambda-extension.git"
8
+ },
5
9
  "main": "dist/index.js",
6
10
  "types": "dist/index.d.ts",
7
11
  "scripts": {
@@ -37,5 +41,8 @@
37
41
  "engines": {
38
42
  "node": ">=16.0.0"
39
43
  },
40
- "files": ["dist/", "README.md"]
44
+ "files": [
45
+ "dist/",
46
+ "README.md"
47
+ ]
41
48
  }