zalando-zmon/zmon-docs

ZMON Documentation

zmon-docs's Issues

Update documentation for logs query in scalyr check command

Add columns in documentation for scalyr check command. zalando-zmon/zmon-worker#328

Document JSON Path functions

Please properly document the JSON Path functions introduced in zalando-zmon/zmon-worker@91ace78

Document Redis info method

is related to zalando-zmon/zmon-worker#421.

Update the Grafana tags list

The current list is outdated.

From zmon-worker

application_id
application_version
stack_name
stack_version
team
account_alias
application
version
account_alias
cluster_alias
alias
spilo_role
namespace

time() function not linkable

i can link to the isoformat() function ... but i cant link to its parent function, because there is already a link to another time() function ...

Correct and extend documentation on value_series

https://docs.zmon.io/en/latest/user/alert-ref/alert_reference_functions.html#value_series

1. Bug: the argument listed in the doc (n=) raises an exception. In reality, this argument is not named.
2. Since one can not trial run the function it would be nice to document the return value. The function returns a list of prior check results with the most recent one being at position 0

Document "headers" HTTP wrapper argument

Weird behaviour in cloud watch ELB metrics

I'm not sure, if this is a bug or just something that should be mentioned in the documentation as a warning, but we are sometimes observing weird behaviour in our ELB based metrics.

We have a cloud watch check, that fetches SUM of requests per second (per minute) and it filters by AvailabilityZone: NOT_SET. Normally, we see the correct values, but there seems to be a race condition, where the values are roughly halved. Values in cloud watch directly are fine

The root cause seems to be a weird timing issue in AWS itself about when it collects the values per AZ to sum them. Why suspect this, since we can get rid of that weird "halving behaviour", when we trigger the forced evaluation of the associated alert a few times to change the timing of when this check runs.

Sorry, I can't really give a better explanation to reproduce this. We only saw this with one check, but there it was very consistent (4 out of 15 measurements consistently showed about half the value of what we saw in cloud watch directly for multiple consecutive days). Triggering forced evaluation of the pulling alert a few times fixed that behaviour.

Document one-time TV tokens

Document how to use TV screen tokens which were implemented with zalando-zmon/zmon-controller#6

Also document "zmon onetime-tokens" CLI usage.

Fix Nagios wrapper docs

Add docs for AWS DataPipeline wrapper

Add docs for AWS DataPipeline wrapper

Update docs on permissions ("authorities")

Update the permission matrix as we no longer support the "LEADS" role.

Update scalyr docs

facets method is not documented.

Documentation is missing information on aggregators & group_by parameters for kairosdb queries.

The subject basically says it all. When reading the zmon manual it remains completely unclear how the parameters aggregators & group_by work and what choices are available.

Idea: How about a link in the manual to this page:
https://kairosdb.github.io/docs/build/html/restapi/QueryMetrics.html?

Thanks,
Moritz

"Downtimes" page needs attention

This page needs detailed how-to information. Or, if it's not too long, we can add it to an existing section.

Several issue worth checking in documentation

1. https://docs.zmon.io/en/latest/intro.html:

• no zmon-eventlog-service on the diagram. However, it is listed in "minimum ZMON setup requirements"
• sentence "ZMON provides many custom wrappers that bind to the selected entity". There should be a link to list of wrappers. If there is no documentation about wrappers - it should be created.
• sentence "ZMON provides many custom wrappers that bind to the selected entity". Better add a screenshot illustrating the sentence.
• sentence "REST API and CLI". Missing link to REST API and CLI documentation

2. https://docs.zmon.io/en/latest/getting-started.html:

• Vagrant is deprecated, better provide a description of setting up with docker compose
• Screenshots illustrating the actions (Create a new Check, Create an Alert, etc) could be useful

3. https://docs.zmon.io/en/latest/user/entities.html

• What is entity "type" and what is it used for?

4. https://docs.zmon.io/en/latest/user/check-definitions.html

• "Using trial run" section lacks description or link to description

5. https://docs.zmon.io/en/latest/user/alert-definitions.html

• Could not find documentation that describes configuration of e-mail and SMS gateways.
• Missing link to https://docs.zmon.io/en/latest/user/notifications.html.

6. https://docs.zmon.io/en/latest/user/dashboards.html

• Need to specify somewhere at the beginning that Flot charts is used for widgets

7. https://docs.zmon.io/en/latest/user/check-commands.html

• Examples are missing for: metric_data, query_logs, count_logs, methods of history
• No information about how to configure access to AWS Cloudwatch
• It's unclear how Counter works until you read that section to the end. Better to put an explanation first. It should explain what counter is, how it's stored, how it's accessed from the checks.
• Elasticsearch. How does that piece authenticate with Elasticsearch if oauth2 parameter is false?
• "If url is None, then the plugin will use the default Elasticsearch cluster set in worker configuration.": worker configuration should be a link pointing to worker documentation
• Better to explain how oauth2_token_name (check HTTP section) works

8. https://docs.zmon.io/en/latest/installation/requirements.html

• Worth adding links to Redis, PostgreSQL and Cassandra projects

time() is not covered in check reference

maybe someone cant point me to the right spot, but it looks to me like the time() function is not covered on what it does or returns in the check reference. it is mentioned several times in the doc, but its not covered in detail on its exact functionalities.

https://github.com/zalando-zmon/zmon-docs/blob/master/docs/user/check-commands.rst
https://docs.zmon.io/en/latest/user/check-commands.html?highlight=timestamp

Proposed changes to main page/TOC, Intro, left-side column

Wondering if we can merge the current page with "Intro," putting the Intro, ZMON Components, and ZMON Origins sections on the front page, inserting a link to "Getting Started" before Origins, then adding a condensed version of the TOC below the Origins paragraph.

Documentation of prometheus flat option

Add documentation about the flat option for prometheus metric scraping.

Document Jolokia method in HTTP wrapper

This method is not yet documented:
https://github.com/zalando/zmon-worker/blob/master/zmon_worker_monitor/builtins/plugins/http.py#L213