traefik/docs/content/observability/tracing/instana.md

118 lines
1.9 KiB
Markdown
Raw Normal View History

---
title: "Traefik Instana Documentation"
description: "Traefik supports several tracing backends, including Instana. Learn how to implement it for observability in Traefik Proxy. Read the technical documentation."
---
2019-06-27 22:16:04 +00:00
# Instana
To enable the Instana tracer:
2019-06-27 22:16:04 +00:00
2019-07-16 07:54:04 +00:00
```yaml tab="File (YAML)"
tracing:
instana: {}
```
```toml tab="File (TOML)"
[tracing]
[tracing.instana]
```
2019-06-27 22:16:04 +00:00
```bash tab="CLI"
2019-07-22 07:58:04 +00:00
--tracing.instana=true
2019-06-27 22:16:04 +00:00
```
#### `localAgentHost`
_Required, Default="127.0.0.1"_
2019-06-27 22:16:04 +00:00
Local Agent Host instructs reporter to send spans to the Instana Agent at this address.
2019-06-27 22:16:04 +00:00
2019-07-16 07:54:04 +00:00
```yaml tab="File (YAML)"
tracing:
instana:
localAgentHost: 127.0.0.1
```
```toml tab="File (TOML)"
[tracing]
[tracing.instana]
localAgentHost = "127.0.0.1"
```
2019-06-27 22:16:04 +00:00
```bash tab="CLI"
--tracing.instana.localAgentHost=127.0.0.1
2019-06-27 22:16:04 +00:00
```
#### `localAgentPort`
_Required, Default=42699_
2019-06-27 22:16:04 +00:00
Local Agent port instructs reporter to send spans to the Instana Agent listening on this port.
2019-06-27 22:16:04 +00:00
2019-07-16 07:54:04 +00:00
```yaml tab="File (YAML)"
tracing:
instana:
localAgentPort: 42699
```
```toml tab="File (TOML)"
[tracing]
[tracing.instana]
localAgentPort = 42699
```
2019-06-27 22:16:04 +00:00
```bash tab="CLI"
--tracing.instana.localAgentPort=42699
```
#### `logLevel`
_Required, Default="info"_
2019-06-27 22:16:04 +00:00
Sets Instana tracer log level.
2019-06-27 22:16:04 +00:00
Valid values are:
2019-06-27 22:16:04 +00:00
- `error`
- `warn`
- `debug`
- `info`
2019-07-16 07:54:04 +00:00
```yaml tab="File (YAML)"
tracing:
instana:
logLevel: info
```
```toml tab="File (TOML)"
[tracing]
[tracing.instana]
logLevel = "info"
```
2019-06-27 22:16:04 +00:00
```bash tab="CLI"
--tracing.instana.logLevel=info
2019-06-27 22:16:04 +00:00
```
#### `enableAutoProfile`
_Required, Default=false_
Enables [automatic profiling](https://www.ibm.com/docs/en/obi/current?topic=instana-profile-processes) for the Traefik process.
```yaml tab="File (YAML)"
tracing:
instana:
enableAutoProfile: true
```
```toml tab="File (TOML)"
[tracing]
[tracing.instana]
enableAutoProfile = true
```
```bash tab="CLI"
--tracing.instana.enableAutoProfile=true
```