Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[chore][connector/servicegraph][processor/servicegraph] Cleanup and copy configuration README #29919

Merged
merged 2 commits into from
Jan 10, 2024
Merged

[chore][connector/servicegraph][processor/servicegraph] Cleanup and copy configuration README #29919

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5cbe9af
[chore] Cleanup and copy configuration README
crobert-1 Dec 15, 2023
51dc0b8
Changes requested
crobert-1 Jan 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions connector/servicegraphconnector/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,31 @@ datasources:
version: 1
```

## Configuration

The following settings are required:

- `metrics_exporter`: the name of the exporter that this processor will write metrics to. This exporter **must** be present in a pipeline.
- `latency_histogram_buckets`: the list of durations defining the latency histogram buckets.
- Default: `[2ms, 4ms, 6ms, 8ms, 10ms, 50ms, 100ms, 200ms, 400ms, 800ms, 1s, 1400ms, 2s, 5s, 10s, 15s]`
- `dimensions`: the list of dimensions to add together with the default dimensions defined above.

The following settings can be optionally configured:

- `store`: defines the config for the in-memory store used to find requests between services by pairing spans.
- `ttl`: TTL is the time to live for items in the store.
- Default: `2s`
- `max_items`: MaxItems is the maximum number of items to keep in the store.
- Default: `1000`
- `cache_loop`: the interval at which to clean the cache.
- Default: `1m`
- `store_expiration_loop`: the time to expire old entries from the store periodically.
- Default: `2s`
- `virtual_node_peer_attributes`: the list of attributes need to match for building virtual server node, the higher the front, the higher the priority.
- Default: `[db.name, net.sock.peer.addr, net.peer.name, rpc.service, net.sock.peer.name, net.peer.name, http.url, http.target]`
- `metrics_flush_interval`: the interval at which metrics are flushed to the exporter.
- Default: Metrics are flushed on every received batch of traces.

## Example configuration

```yaml
Expand Down
13 changes: 7 additions & 6 deletions processor/servicegraphprocessor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,15 +117,16 @@ The following settings are required:

The following settings can be optionally configured:

- `store` defines the config for the in-memory store used to find requests between services by pairing spans.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking of removing the entire contents of the processor's configuration section and directly linking to the connector's section, so we don't have a copy of information that we have to maintain. My concern though is there's a possibility of adding connector-specific options at some point, and also since the processor is deprecated maintaining these duplicates may not be a long term issue.

Happy to use a link instead though if others think that's preferable.

- `ttl` - TTL is the time to live for items in the store.
- `store`: defines the config for the in-memory store used to find requests between services by pairing spans.
- `ttl`: TTL is the time to live for items in the store.
- Default: `2s`
- `max_items` - MaxItems is the maximum number of items to keep in the store.
- `max_items`: MaxItems is the maximum number of items to keep in the store.
- Default: `1000`
- `cache_loop` - the time to cleans the cache periodically
- `store_expiration_loop` the time to expire old entries from the store periodically.
- `virtual_node_peer_attributes` the list of attributes need to match for building virtual server node, the higher the front, the higher the priority.
- `cache_loop`: the interval at which to clean the cache.
- `store_expiration_loop`: the time to expire old entries from the store periodically.
- `virtual_node_peer_attributes`: the list of attributes need to match for building virtual server node, the higher the front, the higher the priority.
- Default: `[db.name, net.sock.peer.addr, net.peer.name, rpc.service, net.sock.peer.name, net.peer.name, http.url, http.target]`
- `metrics_flush_interval`: the interval at which metrics are flushed to the exporter. Metrics are flush on every received batch of traces by default.

## Example configuration

Expand Down