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.

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

[Synthetics] Adds additional heartbeat configuration options to the Synthetics app #154390

Conversation

dominiqueclarke
Copy link
Contributor

@dominiqueclarke dominiqueclarke commented Apr 4, 2023

Summary

Closes #140864
Relates to https://github.com/elastic/synthetics-dev/issues/159
Relates to elastic/synthetics#655

Adds missing heartbeat configs to the Synthetics app. The additional configs are specified below:

HTTP (proxy_headers, mode, ipv4, ipv6, response.include_body_max_bytes, check.response.json)
image
image

TCP (mode, ipv4, ivp6)
image

ICMP (mode, ipv4, ipv6)
image

Testing

  1. Create a private location
  2. Create an http monitor selecting both a public and private location, adjusting the settings for mode, ipv4, ipv6, response.include_body_max_bytes, check.response.json and proxy headers.
  3. Navigate to the edit page for that monitor, ensure the configuration above was saved to the monitor settings
  4. Create an icmp monitor selecting both a public and private location, adjusting the settings for mode, ipv6, and ipv4.
  5. Navigate to the dit page for that monitor, ensure the configuration above was saved to the monitor settings
  6. Create an tcp monitor selecting both a public and private location, adjusting the settings for mode, ipv6, and ipv4.
  7. Navigate to the dit page for that monitor, ensure the configuration above was saved to the monitor settings
  8. Navigate to the agent policy for the private location selected. Ensure that the configuration options are represented on the the individual integration policies

@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@dominiqueclarke dominiqueclarke added enhancement New value added to drive a business result Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability v8.8.0 labels Apr 11, 2023
@dominiqueclarke dominiqueclarke changed the title add mode to http monitors [Synthetics] Adds additional heartbeat configuration options to the Synthetics app Apr 11, 2023
@dominiqueclarke dominiqueclarke marked this pull request as ready for review April 11, 2023 02:36
@dominiqueclarke dominiqueclarke requested a review from a team as a code owner April 11, 2023 02:36
@elasticmachine
Copy link
Contributor

Pinging @elastic/uptime (Team:uptime)

@dominiqueclarke dominiqueclarke added the release_note:skip Skip the PR/issue when compiling release notes label Apr 11, 2023
@dominiqueclarke
Copy link
Contributor Author

@elasticmachine merge upstream

Copy link
Contributor

@florent-leborgne florent-leborgne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice content! I have mostly minor wording style suggestions. I hope I haven't missed anything :)

fieldKey: ConfigKey.RESPONSE_JSON_CHECK,
component: KeyValuePairsField,
label: i18n.translate('xpack.synthetics.monitorConfig.responseJSON.label', {
defaultMessage: 'Check response body contains JSON',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed that all labels for similar settings are like this. I'd suggest 2 improvements depending on what is possible, timely and realistic to do:

  1. Have simple labels and use the operators as preset fields (a bit like what the JSON setting looks like), for example:
    Response status
    Equals to input field...
    Response body
    Contains input field...
    some help text
    Does not contain input field...
    some help text

  2. Quick label structure improvement: remove "Check". It's already explained in the section description and name "Response checks"

  • Response body contains JSON
  • Response status equals to
  • Response headers contain
  • etc.

fieldKey: ConfigKey.PROXY_HEADERS,
component: HeaderField,
label: i18n.translate('xpack.synthetics.monitorConfig.proxyHeaders.label', {
defaultMessage: 'Proxy headers',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not very content related, but I'm wondering from the screenshots if it wouldn't be clearer to have the "+ Add expression", "+ Add header" and similar types of button below the setting descriptions and values already added. Just thinking in terms of layout. Maybe it'd look odd as well, not sure.

dominiqueclarke and others added 7 commits April 12, 2023 08:02
…nitor_add_edit/form/field_config.tsx

Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
…nitor_add_edit/form/field_config.tsx

Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
…nitor_add_edit/form/field_config.tsx

Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
…nitor_add_edit/form/field_config.tsx

Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
…nitor_add_edit/form/field_config.tsx

Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
@@ -90,7 +90,7 @@ const getNearestSupportedSchedule = (currentSchedule: string): string => {

return closest;
} catch {
return ALLOWED_SCHEDULES_IN_MINUTES[0];
return '10';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this intended?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is. Paul and I had a conversation about this, and I decided to just make this quick change in this PR.

Copy link
Contributor

@shahzad31 shahzad31 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested newly added configs !!

Works as expected !!

dominiqueclarke and others added 6 commits April 24, 2023 21:11
…nitor_add_edit/form/field_config.tsx

Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
…nitor_add_edit/form/field_config.tsx

Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
synthetics 1.2MB 1.2MB +5.8KB
Unknown metric groups

ESLint disabled line counts

id before after diff
enterpriseSearch 17 19 +2
securitySolution 397 400 +3
total +5

Total ESLint disabled count

id before after diff
enterpriseSearch 18 20 +2
securitySolution 477 480 +3
total +5

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@dominiqueclarke dominiqueclarke merged commit c3ccede into elastic:main Apr 25, 2023
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Apr 25, 2023
@dominiqueclarke dominiqueclarke deleted the feat/synthetics-add-extra-heartbeat-configs branch April 25, 2023 12:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting enhancement New value added to drive a business result release_note:skip Skip the PR/issue when compiling release notes Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability v8.8.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Synthetics] Normalizing Heartbeat YML from synthetics agent for monitor management
7 participants