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

add user-agent spec + gherkin spec #514

Merged
merged 5 commits into from
Oct 12, 2021
Merged

add user-agent spec + gherkin spec #514

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5b9fd1e
add user-agent spec + gherkin spec
SylvainJuge Sep 27, 2021
65a08b6
update regex
SylvainJuge Sep 27, 2021
870dfbe
make regex a bit more strict
SylvainJuge Sep 28, 2021
ab86083
wording fix specs/agents/transport.md
SylvainJuge Sep 29, 2021
0e2bc44
align spec to es-client user-agent header
SylvainJuge Oct 11, 2021
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
15 changes: 15 additions & 0 deletions specs/agents/transport.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,21 @@

Agents send data to the APM Server as JSON (application/json) or ND-JSON (application/x-ndjson) over HTTP. We describe here various details to guide transport implementation.

### User-Agent

In order to help debugging and gathering usage statistics, agents should use one of the following values for the `User-Agent` HTTP header:

- Header value should start with agent github repository as prefix and version `apm-agent-${language}/${agent.version}`.
- If both `service.name` and `service.version` are set, append ` (${service.name} ${service.version})`
- If only `service.name` is set, append `(${service.name})`

An executable gherkin specification is also provided in [user_agent.feature](../../tests/agents/gherkin-specs/user_agent.feature).

Examples:
- `apm-agent-java/v1.25.0`
- `apm-agent-ruby/4.4.0 (myservice)`
- `apm-agent-python/6.4.0 (myservice v42.7)`

trentm marked this conversation as resolved.
Show resolved Hide resolved
### Background sending

In order to avoid impacting application performance and behaviour, agents should (where possible) send data in a non-blocking manner, e.g. via a background thread/goroutine/process/what-have-you, or using asynchronous I/O.
Expand Down
19 changes: 19 additions & 0 deletions tests/agents/gherkin-specs/user_agent.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Feature: Agent Transport User agent Header

Scenario: Default user-agent
Given an agent
When service name is not set
When service version is not set
Then the User-Agent header matches regex '^apm-agent-[a-z]+/[^ ]*'

Scenario: User-agent with service name only
Given an agent
When service name is set to 'myService'
When service version is not set
Then the User-Agent header matches regex '^apm-agent-[a-z]+/[^ ]* \(myService\)'

Scenario: User-agent with service name and service version
Given an agent
When service name is set to 'myService'
When service version is set to 'v42'
Then the User-Agent header matches regex '^apm-agent-[a-z]+/[^ ]* \(myService v42\)'