Skip to content

Commit 91793c9

Browse files
committed
update readme.md
1 parent 423bf42 commit 91793c9

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,25 @@ export default new TailExporter({
173173
});
174174
```
175175

176+
### Default log
177+
178+
The Tail Exporter can emit a small set of built-in logs per sink via the `defaultLogsEnabled` option (used by sinks such as `OtelLogSink`). The most common default log is:
179+
180+
- `invocationLog` (default: `true`): emits a per-invocation log record containing metadata about the invocation (script name, execution model, outcome, versionId), timing information, and any global tags. This complements automatic `console` capture and is useful for tracing, auditing, and correlating metrics with individual invocations.
181+
182+
To disable the invocation log for a sink, set:
183+
184+
```ts
185+
new OtelLogSink({
186+
...
187+
defaultLogsEnabled: {
188+
invocationLog: false;
189+
};
190+
}),
191+
```
192+
193+
You can enable or disable default logs per sink when constructing the sink (see the `OtelLogSink` example above).
194+
176195
2. Set up Datadog API key:
177196

178197
```bash
@@ -243,3 +262,5 @@ export default new TailExporter({
243262
}
244263
});
245264
```
265+
266+

0 commit comments

Comments
 (0)