-
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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 Kibana's. | ||||||
|
||||||
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 Kibana's. | ||||||
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.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). | ||||||
:::: | ||||||
|
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. |
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.