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

Elastic Synthetic Identifier In UA String #232

Closed
paulb-elastic opened this issue Mar 1, 2021 · 1 comment · Fixed by #380
Closed

Elastic Synthetic Identifier In UA String #232

paulb-elastic opened this issue Mar 1, 2021 · 1 comment · Fixed by #380
Assignees
@dominiqueclarke
Labels
good first issue Good for newcomers refined Issue refined, ready to work on

Comments

@paulb-elastic
Copy link
Contributor

paulb-elastic commented Mar 1, 2021 •
edited
Loading

As a Synthetics user
I want to be able to easily identify Elastic Synthetic traffic in my analytics
So that I can exclude such traffic from my visitor volumes as this monitoring skews real customer figures

ACs:

  • The user agent string should include some kind of addition to identify monitors running from Elastic Synthetics (appending Elastic/Synthetics to the actual UA string)
  • It must still be possible to identify the actual browser making the requests (i.e. it won't remove or overwrite the natural UA string completely)
  • There must be a configuration parameter (boolean) associated with the monitor to control this behaviour, defaulted to enabled (needed for the rare cases where a non standard UA string may cause problems with UA sniffing)

Referencing somewhat related tickets:
@paulb-elastic paulb-elastic mentioned this issue Mar 1, 2021
Closed
30 tasks
@vigneshshanmugam vigneshshanmugam added the good first issue Good for newcomers label Aug 26, 2021
@paulb-elastic paulb-elastic added the refined Issue refined, ready to work on label Sep 14, 2021
@shahzad31 shahzad31 self-assigned this Sep 20, 2021
@shahzad31 shahzad31 mentioned this issue Sep 20, 2021
Merged
@shahzad31 shahzad31 removed their assignment Oct 27, 2021
@dominiqueclarke dominiqueclarke self-assigned this Nov 1, 2021
@dominiqueclarke
Copy link
Contributor

Seeing Elastic/Synthetics appended in the user agent when run in headful mode on version beta-16.

Screen Shot 2021-11-01 at 4 10 08 PM

@zube zube bot removed the [zube]: Done label Dec 21, 2021
andrewvc added a commit to andrewvc/synthetics-1 that referenced this issue May 26, 2022
@andrewvc
Only append 'Elastic/Synthetics' to default UA
d1ed2e3 
When we originally implemented
elastic#232 it appears we didn't
implement the third AC, allowing users to override our custom UA string
"Elastic/Synthetics" which is appended.

Some users need to fully replace the UA, this allows them to do that.
Rather than adding a boolean, this assumes that if you're overriding the
UA you want full control, which is more in line with the principle of
least surprise.
@andrewvc andrewvc mentioned this issue May 26, 2022
Merged
vigneshshanmugam pushed a commit to andrewvc/synthetics-1 that referenced this issue Jun 3, 2022
@andrewvc @vigneshshanmugam
Only append 'Elastic/Synthetics' to default UA
6f271c7 
When we originally implemented
elastic#232 it appears we didn't
implement the third AC, allowing users to override our custom UA string
"Elastic/Synthetics" which is appended.

Some users need to fully replace the UA, this allows them to do that.
Rather than adding a boolean, this assumes that if you're overriding the
UA you want full control, which is more in line with the principle of
least surprise.
vigneshshanmugam added a commit that referenced this issue Jun 3, 2022
@andrewvc @vigneshshanmugam
fix: only append 'Elastic/Synthetics' to default UA (#514)
f7a5c8f 
* Only append 'Elastic/Synthetics' to default UA

When we originally implemented
#232 it appears we didn't
implement the third AC, allowing users to override our custom UA string
"Elastic/Synthetics" which is appended.

Some users need to fully replace the UA, this allows them to do that.
Rather than adding a boolean, this assumes that if you're overriding the
UA you want full control, which is more in line with the principle of
least surprise.

* fix tests and rebase

Co-authored-by: vigneshshanmugam <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dominiqueclarke dominiqueclarke

Labels
good first issue Good for newcomers refined Issue refined, ready to work on
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Append Elastic/synthetics to UA string elastic/synthetics
4 participants
@shahzad31 @vigneshshanmugam @dominiqueclarke @paulb-elastic