-
Notifications
You must be signed in to change notification settings - Fork 155
[Synthetics] Add proxy settings docs #3380
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.
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
Open
emilioalvap
wants to merge
2
commits into
main
Choose a base branch
from
synthetics-proxy-options
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -186,6 +186,26 @@ If the journey contains external NPM packages other than the `@elastic/synthetic | |||||
* If you `push` a Synthetics project that used to contain one or more monitors but no longer contains any monitors, all monitors associated with the Synthetics project ID being pushed will be deleted. | ||||||
* If you `push` a Synthetics project that’s already been pushed using one Synthetics project ID and then try to `push` it using a *different* ID, it will create duplicates of all monitors in the Synthetics project. | ||||||
|
||||||
`--proxy-uri` | ||||||
: The Proxy URL to be used when connecting to the deployment or Observability Serverless project. | ||||||
|
||||||
This can also be set in the configuration file using [`proxy.uri` in the configuration file](/solutions/observability/synthetics/configure-projects.md#synthetics-configuration-proxy). The value defined via the CLI will take precedence. | ||||||
|
||||||
`--proxy-token` | ||||||
: (Optional) The authentication token to be used when connecting to the proxy url. Based in auth header format `Basic Asaaas==` | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
This can also be set in the configuration file using [`proxy.token` in the configuration file](/solutions/observability/synthetics/configure-projects.md#synthetics-configuration-proxy). The value defined via the CLI will take precedence. | ||||||
|
||||||
`--proxy-ca` | ||||||
: (Optional) Override the trusted CA certificates for the proxy connection. | ||||||
|
||||||
This can also be set in the configuration file using [`proxy.ca` in the configuration file](/solutions/observability/synthetics/configure-projects.md#synthetics-configuration-proxy). The value defined via the CLI will take precedence. | ||||||
|
||||||
`--proxy-no-verify` | ||||||
: (Optional) Disable TLS verification for the proxy connection. | ||||||
|
||||||
This can also be set in the configuration file using [`proxy.noVerify` in the configuration file](/solutions/observability/synthetics/configure-projects.md#synthetics-configuration-proxy). The value defined via the CLI will take precedence. | ||||||
|
||||||
## Tag monitors [tagging-and-filtering] | ||||||
|
||||||
Synthetics journeys can be tagged with one or more tags. Use tags to filter journeys when running tests locally or pushing them to Elastic. | ||||||
|
@@ -251,6 +271,27 @@ To list both locations on Elastic’s global managed infrastructure and {{privat | |||||
`--auth <string>` | ||||||
: API key used for [authentication](/deploy-manage/api-keys/elasticsearch-api-keys.md). | ||||||
|
||||||
`--proxy-uri` | ||||||
: The Proxy URL to be used when connecting to the deployment or Observability Serverless project. | ||||||
|
||||||
This can also be set in the configuration file using [`proxy.uri` in the configuration file](/solutions/observability/synthetics/configure-projects.md#synthetics-configuration-proxy). The value defined via the CLI will take precedence. | ||||||
|
||||||
`--proxy-token` | ||||||
: (Optional) The authentication token to be used when connecting to the proxy url. Based in auth header format `Basic Asaaas==` | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
This can also be set in the configuration file using [`proxy.token` in the configuration file](/solutions/observability/synthetics/configure-projects.md#synthetics-configuration-proxy). The value defined via the CLI will take precedence. | ||||||
|
||||||
`--proxy-ca` | ||||||
: (Optional) Override the trusted CA certificates for the proxy connection. | ||||||
|
||||||
This can also be set in the configuration file using [`proxy.ca` in the configuration file](/solutions/observability/synthetics/configure-projects.md#synthetics-configuration-proxy). The value defined via the CLI will take precedence. | ||||||
|
||||||
`--proxy-no-verify` | ||||||
: (Optional) Disable TLS verification for the proxy connection. | ||||||
|
||||||
This can also be set in the configuration file using [`proxy.noVerify` in the configuration file](/solutions/observability/synthetics/configure-projects.md#synthetics-configuration-proxy). The value defined via the CLI will take precedence. | ||||||
|
||||||
|
||||||
::::{note} | ||||||
If an administrator has disabled Elastic managed locations for the role you are assigned and you do *not* include `--url` and `--auth`, all global locations managed by Elastic will be listed. However, you will not be able to push to these locations with your API key and will see an error: *You don’t have permission to use Elastic managed global locations*. For more details, refer to the [troubleshooting docs](/troubleshoot/observability/troubleshooting-synthetics.md#synthetics-troubleshooting-public-locations-disabled). | ||||||
:::: | ||||||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -284,4 +284,18 @@ $$$synthetics-configuration-monitor-tags$$$ `tags` (`Array<string>`) | |||||
For information on configuring monitors individually, refer to: | ||||||
|
||||||
* [Configure individual browser monitors](/solutions/observability/synthetics/configure-individual-browser-monitors.md) for browser monitors | ||||||
* [Configure lightweight monitors](/solutions/observability/synthetics/configure-lightweight-monitors.md) for lightweight monitors | ||||||
* [Configure lightweight monitors](/solutions/observability/synthetics/configure-lightweight-monitors.md) for lightweight monitors | ||||||
|
||||||
## `proxy` [synthetics-configuration-proxy] | ||||||
|
||||||
`uri` (`string`) | ||||||
: The Proxy URL to be used when connecting to the deployment or Observability Serverless project. | ||||||
|
||||||
`token` (`string`) | ||||||
: (Optional) The authentication token to be used when connecting to the proxy url. Based in auth header format `Basic Asaaas==` | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
`ca` (`string | Buffer`) | ||||||
: (Optional) Override the trusted CA certificates for the proxy connection. | ||||||
|
||||||
`noVerify` (`boolean`) | ||||||
: (Optional) Disable TLS verification for the proxy connection. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To Kibana right? can we call that out?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, good call 👍