[DOC] Feedback on Alerting/Observability topics

[hdhalter]

What do you want to do?

x Request a change to existing documentation

Tell us about your request. Provide a summary of the request and all versions that are affected.
Feedback from users on Alerting/Monitor/Observability topics:

• 20230411 | /docs/2.6/observing-your-data/alerting/index/ | Needs more information (alerting content has been reworked since comment was entered)
• 20230411 | /docs/latest/observing-your-data/alerting/monitors/ | Detail information about opensearch monitors.
• 20230509 | /docs/latest/observing-your-data/alerting/monitors/ | How does one detect when there is a state change on an alert? Ideally, how does one watch/catch/observe an alert state change to trigger on it? Documentation is missing. DEV writing lead
• 20230521 | /docs/latest/observing-your-data/alerting/index/ | there is no detail on how to use alerting (alerting content has been reworked since comment was entered)
• 20230526 |/docs/latest/observing-your-data/alerting/monitors/ |Sample script does not says in which language you should write or what to return DEV writing lead
• 20230503 |/docs/latest/observing-your-data/log-ingestion/ |documentation does not match repo it refers to. inconsistencies. DEV writing lead
• 20230301 |/docs/latest/observing-your-data/sso/ |Reading this page I have no clue as to any of the specifics or where to go for more information. What is the structure of the schema? What are the fields? How does one map their events onto the schema? DEV writing lead
• 20230405 | /docs/latest/observing-your-data/prometheusmetrics/ | This method doesn't works! (Content has been reworked since comment was entered) DEV writing lead
• 20230705 | /docs/latest/observing-your-data/prometheusmetrics/ | I cnat find anywere how to install plugins on remote opensearch host, like exaple prometheus DEV writing lead
• 20230801 | /docs/2.7/observing-your-data/log-ingestion/ | Is Fluent Bit the only support agent for log ingestion?ig? Can I use promtail? What about Filebeat conf DEV writing lead
• 20230731 | /docs/latest/observing-your-data/prometheusmetrics/ | How to add the SQL plugin mentioned here? ometheusmetrics/#configuring-a-data-source-connection-from-prometheus-to-opensearch - https://opensearch.org/docs/latest/observing-your-data/pr DEV writing lead
• 20230726 | /docs/latest/observing-your-data/trace/trace-analytics-jaeger/ | This docker compose example doesnt work i dont get traces in opensearch. i just get the info on the trace analytics page: Trace Analytics not set up The indices required for trace analytics (jaeger-span- and jaeger-service) do not exist or you do not have permission to access them. DEV writing lead
• 20230704 | /docs/latest/observing-your-data/notifications/index/ | I'm using docker-compose for the setup there I cannot find opensearch.notifications.core.email.<sender_name>.username DEV writing lead
• 20231015 | /docs/latest/observing-your-data/trace/trace-analytics-jaeger/ | When i run this file a see an error in jaeger-hotrod-hotrod-1 container logs like "traces export: Post http://localhost:4318/v1/traces: dial tcp 127.0.0.1:4318: connect: connection refused' DEV writing lead
• 20230823 | /docs/latest/observing-your-data/alerting/actions/ | Can we implement our custom variable in OpenSearch that answer is not here DEV writing lead
• 20230828 | /docs/latest/observing-your-data/alerting/per-document-monitors/ | Would like to see examples of queries DEV writing lead
• 20230926 | /docs/latest/observing-your-data/notifications/index/ | need more specific WHAT SPECIFICS ARE NEEDED?
• 20230927 | /docs/latest/observing-your-data/alerting/triggers/ | There is no detailing around how to setup bucket level triggers. DEV writing lead
• 20231009 | /docs/latest/observing-your-data/alerting/per-query-bucket-monitors/ | > "Start" and "end" refer ... Where does this "Start"/"end" points to? period_start/end ? or timestamp from/to ? it's unclear for me. DEV writing lead
• 20231010 | /docs/2.10/observing-your-data/trace/getting-started/ | i got error like this "Failed to initialize OpenSearch sink, retrying: PKIX path validation failed: DEV writing lead
• 20230929 | /docs/latest/observing-your-data/ss4o/ | There isn't any information or links to how to set any of this up on this page. saying it can do this or that but without any "how" is not that helpful.
• 20231024 | /docs/latest/observing-your-data/notifications/index/ | I came here from wazuh to set smtp password for notificaiton but there is no opensearch direcotry how do i use email notificaitons…
• 20231024 | /docs/latest/observing-your-data/notifications/index/ | I can't find where the contents of a notification are discussed.
• 20231026 | /docs/latest/observing-your-data/notifications/index/ | "response_time_min": { "min": { "script": "doc['metric_type.keyword'].value == 'Average Response Time (ms)' ? doc['minVal'].value/1000 : 0" } }
• 20231031 | /docs/latest/observing-your-data/notifications/index/ | These pages need more screenshots.
• 20231020 | /docs/latest/observing-your-data/prometheusmetrics/ | How do you ingest metrics from an index, e.g. data-prepper metrics-otel-v1-*?
• 20231208 | /docs/latest/observing-your-data/trace/trace-analytics-jaeger/ | The POC isn't working himself..

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

[hdhalter]

Hi @vagimeli , while you are working on alerting for 2.8, maybe you can address these issues? Thanks!

[vagimeli]

@hdhalter Feedback is being addressed as we revise and add new documentation. For visibility, I'll link this issue to PRs as feedback is addressed.

[vagimeli]

Status update: 20230411 | /docs/latest/observing-your-data/alerting/monitors/ | Detail information about opensearch monitors

See PR #3453

[hdhalter]

@vagimeli - do you mean you addressed the comment on monitors in this PR: https://github.com/opensearch-project/documentation-website/pull/4024/files?

[vagimeli]

@hdhalter Most of these topics involve backend developer insight. I've noted those that require the dev to be the doc writing lead.

[hdhalter]

@vagimeli - Why did you close this?

[vagimeli]

@hdhalter

@vagimeli - Why did you close this?

I was clearing out issues that were months or year+ old and haven't had any developer response.

[vagimeli]

@hdhalter Who are the developers assigned to this topic area? Before writing can get started, we need to know if the developer has any existing documentation they created while developing this feature. I don't have any resources that have been shared with me to date. Thanks!