Skip to content

Update synthetics nerdgraph examples to indicate optional fields more clearly #20718

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

Open
shevaun-nr wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Update synthetics nerdgraph examples to indicate optional fields more clearly #20718

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f12459e
mark monitor configuration fields as optional and add detaults
shevaun-nr May 20, 2025
1b33e84
Merge branch 'newrelic:develop' into update-synthetics-nerdgraph-exam…
shevaun-nr May 20, 2025
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
20 changes: 10 additions & 10 deletions src/content/docs/apis/nerdgraph/examples/nerdgraph-synthetics-tutorial.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,28 +97,28 @@ Configure simple browser, scripted browser, and step monitors to use one or more

<Collapser
id="optional-fields"
title="Define optional fields"
title="Define fields for specific monitor types"
>
Some fields are for more advanced configurations. These are optional.
Some fields detail additional configurations for specific monitor types. Use the fields related to the type of monitor you are creating or updating. These fields are required unless indicated otherwise.

For [ping monitors](#create-ping), these include:

* `HEADER_NAME`: Your custom header names that appear on the request.
* `HEADER_NAME`: Your custom header names that appear on the request. (optional)

* `HEADER_VALUE`: The custom header value on the request.
* `HEADER_VALUE`: The custom header value on the request. (optional)

* `REDIRECT_IS_FAILURE`: Your monitor reports a failure if it's redirected.
* `REDIRECT_IS_FAILURE`: Your monitor reports a failure if it's redirected. Defaults to false. (optional)

* `VALIDATION_TEXT`: If this text is not included in your monitor's response, it returns a failure.
* `VALIDATION_TEXT`: If this text is not included in your monitor's response, it returns a failure. (optional)

* `TLS_VALIDATION`: Verifies the [validity](/docs/synthetics/synthetic-monitoring/using-monitors/add-edit-monitors/#simple) of the SSL certificate chain.
* `TLS_VALIDATION`: Verifies the [validity](/docs/synthetics/synthetic-monitoring/using-monitors/add-edit-monitors/#simple) of the SSL certificate chain. Defaults to false. (optional)

* `BYPASS_HEAD_REQUEST`: Bypasses the initial HEAD request and instead makes a GET request.
* `BYPASS_HEAD_REQUEST`: Bypasses the initial HEAD request and instead makes a GET request. Defaults to false. (optional)


For [simple browser monitors](#create-simple-browser):

* `RUNTIME_TYPE`: The runtime type used by your monitor. "CHROME_BROWSER" is the only accepted value.
* `RUNTIME_TYPE`: The runtime type used by your monitor. "CHROME_BROWSER" is the only accepted value.

* `RUNTIME_TYPE_VERSION`: The runtime type version used by your monitor. "100" is the only accepted value.

Expand Down Expand Up @@ -178,7 +178,7 @@ Configure simple browser, scripted browser, and step monitors to use one or more

For all monitors:

* `APDEX_TARGET`: The monitor's Apdex target used to populate SLA reports. Defaults to 7 seconds (7000ms).
* `APDEX_TARGET`: The monitor's Apdex target used to populate SLA reports. Defaults to 7 seconds (7000ms). (optional)
</Collapser>
</CollapserGroup>

Expand Down