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] - add meta information to monitoring data #729

Closed
jalogisch opened this issue Mar 2, 2023 · 11 comments · Fixed by #959
Closed

[Synthetics] - add meta information to monitoring data #729

jalogisch opened this issue Mar 2, 2023 · 11 comments · Fixed by #959
Assignees
Labels
Team:Uptime Label for the Uptime team

Comments

@jalogisch
Copy link
Member

Describe the feature:

When you create monitoring for different URLs (as example) in Synthetics, you want to have the ability to add additional fields and information to the data that is stored in elasticsearch as a result of these monitors.

Describe a specific use case for the feature:

When you monitor different applications or business areas, you want to have the ability to have a single field that allows you across all your data to get the information for this specific business area.

So you want to add to all relevant data to your website one field with the same value. - area:website - that allows you to search all available data, web server logs, database, uptime checks, and application logs for everything related to that specific area.
In addition, you could allow access based on this field to specific teams and contractors only.

All of this would allow having the important data in a single place, creating dashboards with sourcing different logs and data sources to create one big picture that enables operators to get a quick overview.

@shahzad31 shahzad31 added the Team:Uptime Label for the Uptime team label Mar 2, 2023
@elasticmachine
Copy link

Pinging @elastic/uptime (Team:uptime)

@paulb-elastic
Copy link
Contributor

Our current approach for something similar is to use tags to group similar monitors together (multiple tags can be defined per monitor). How does this requirement differ from that?

@philippkahr
Copy link

@paulb-elastic ah I see what you want todo. That is not the plan here. This is a bit of an inconsistency across all integrations, nonetheless most of them supply a processor configuration. Therefore you can run a certain amount of processors (usually those: https://www.elastic.co/guide/en/beats/filebeat/current/defining-processors.html and do things, like add custom fields.

Screenshot 2023-03-29 at 16 02 50

@paulb-elastic
Copy link
Contributor

Thanks for clarifying.

As you’re aware, we don’t expose any of the Synthetics Integration configuration, and this is by design. We’ve been careful to ensure configurations are managed from within the Synthetics UI (earlier, Uptime Monitor Management), so that we can abstract the monitor configuration from the underlying implementation and be sure things are set up correctly. That’s effectively why we have an opinionated UI (or definition for Project Monitors) in Synthetics and force all configurations through there.

As such, adding the above capability is more likely to end up being a monitor configuration, either through the UI, or as a Project Monitor configuration for example (via the DSL).

I’ll move this over to the Synthetics repo and put it on our backlog, but for transparency, we’re focusing on the core requirements for Synthetics right now, so won’t be able to look at this any time soon.

@paulb-elastic paulb-elastic transferred this issue from elastic/kibana Apr 3, 2023
@vigneshshanmugam
Copy link
Member

Related #750

@dejongm
Copy link

dejongm commented Feb 14, 2024

We're migrating to Synthetics from Heartbeat and this feature is very much a requirement for us to move forward without implementing some messy workarounds. Can we get a status, regarding progress or timeline on this?

@shahzad31
Copy link
Contributor

@dejongm @jalogisch do you expect those meta fields to be insert at the root of the documents? or would it suffice if they are nested let's say under a field meta : {area: website} it might be bit difficult for us to append at root , since that may have mappings repercussions. Appending under meta or lets say labels would be pretty easy and can be done in near term.

@philippkahr
Copy link

I would rather do labels as this is in ECS and I have seen it more commonly in the wild with like labels.team: abc.

@jalogisch
Copy link
Member Author

I second the ECS Compliant solution.

@shahzad31 shahzad31 self-assigned this Sep 19, 2024
@herrBez
Copy link

herrBez commented Sep 19, 2024

If you need to rename the labels to the expected fields, you can always use the Ingest Pipeline synthetics@custom.

@dejongm
Copy link

dejongm commented Sep 19, 2024

I agree to adhere with the ECS and nest them under labels.

shahzad31 added a commit to elastic/kibana that referenced this issue Sep 20, 2024
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Sep 20, 2024
kibanamachine referenced this issue in elastic/kibana Sep 20, 2024
# Backport

This will backport the following commits from `main` to `8.x`:
- [[Synthetics] Add labels field !!
(#193250)](#193250)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT
[{"author":{"name":"Shahzad","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-09-20T10:50:41Z","message":"[Synthetics]
Add labels field !! (#193250)\n\n## Summary\r\n\r\nPart of
https://github.com/elastic/synthetics/issues/729\r\n\r\nAdd labels
fields !!\r\n\r\nShow them in details \r\n\r\n<img width=\"1520\"
alt=\"image\"\r\nsrc=\"https://github.com/user-attachments/assets/36050903-d2bc-458e-9f10-a912be76a9e9\">\r\n\r\nFrom
add/edit configs \r\n\r\n<img width=\"1718\"
alt=\"image\"\r\nsrc=\"https://github.com/user-attachments/assets/c3ed615e-cf0f-47f5-93f4-da9464add031\">\r\n\r\nas
part of es docs\r\n\r\n<img width=\"1728\"
alt=\"image\"\r\nsrc=\"https://github.com/user-attachments/assets/35a2c4d3-a1b1-4712-a45b-19750543e82d\">","sha":"ca018a7c890c6e297d1314d9fc4cef6a7f8f741a","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["v9.0.0","release_note:feature","backport:prev-minor","ci:project-deploy-observability","Team:obs-ux-management"],"title":"[Synthetics]
Add labels field
!!","number":193250,"url":"https://github.com/elastic/kibana/pull/193250","mergeCommit":{"message":"[Synthetics]
Add labels field !! (#193250)\n\n## Summary\r\n\r\nPart of
https://github.com/elastic/synthetics/issues/729\r\n\r\nAdd labels
fields !!\r\n\r\nShow them in details \r\n\r\n<img width=\"1520\"
alt=\"image\"\r\nsrc=\"https://github.com/user-attachments/assets/36050903-d2bc-458e-9f10-a912be76a9e9\">\r\n\r\nFrom
add/edit configs \r\n\r\n<img width=\"1718\"
alt=\"image\"\r\nsrc=\"https://github.com/user-attachments/assets/c3ed615e-cf0f-47f5-93f4-da9464add031\">\r\n\r\nas
part of es docs\r\n\r\n<img width=\"1728\"
alt=\"image\"\r\nsrc=\"https://github.com/user-attachments/assets/35a2c4d3-a1b1-4712-a45b-19750543e82d\">","sha":"ca018a7c890c6e297d1314d9fc4cef6a7f8f741a"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/193250","number":193250,"mergeCommit":{"message":"[Synthetics]
Add labels field !! (#193250)\n\n## Summary\r\n\r\nPart of
https://github.com/elastic/synthetics/issues/729\r\n\r\nAdd labels
fields !!\r\n\r\nShow them in details \r\n\r\n<img width=\"1520\"
alt=\"image\"\r\nsrc=\"https://github.com/user-attachments/assets/36050903-d2bc-458e-9f10-a912be76a9e9\">\r\n\r\nFrom
add/edit configs \r\n\r\n<img width=\"1718\"
alt=\"image\"\r\nsrc=\"https://github.com/user-attachments/assets/c3ed615e-cf0f-47f5-93f4-da9464add031\">\r\n\r\nas
part of es docs\r\n\r\n<img width=\"1728\"
alt=\"image\"\r\nsrc=\"https://github.com/user-attachments/assets/35a2c4d3-a1b1-4712-a45b-19750543e82d\">","sha":"ca018a7c890c6e297d1314d9fc4cef6a7f8f741a"}}]}]
BACKPORT-->

Co-authored-by: Shahzad <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Uptime Label for the Uptime team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

8 participants