Skip to content
This repository has been archived by the owner on Apr 22, 2020. It is now read-only.

address some of the notes #95

Merged
merged 5 commits into from
Jan 23, 2018
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
2 changes: 1 addition & 1 deletion docs/user/alert-definitions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The following fields exist for alert definitions:
Additional filter to apply the alert definition only to a subset of entities.

notifications
List of notification commands, e.g. to send out emails.
List of :ref:`notification <notifications>` commands, e.g. to send out emails.

time_period
Notification time period.
Expand Down
8 changes: 4 additions & 4 deletions docs/user/entities.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ Entities
Entities describe what you want to monitor in your infrastructure.
This can be as basic as a host, with its attributes hostname and IP; or something more complex, like a PostgreSQL sharded cluster with its identifier and set of connection strings.

ZMON gives you two options for autonomation in/integration with your platform: storing entities via zmon-controller_'s entity service, or discovering them via the adapters in zmon-scheduler_.
ZMON gives you two options for automation in/integration with your platform: storing entities via zmon-controller_'s entity service, or discovering them via the adapters in zmon-scheduler_.
At Zalando we use both, connecting ZMON to tools like our CMDB but also pushing entities via REST API.

ZMON's entity service describes entities with a single JSON document.
Any entity must contain an ID that is unique within your ZMON deployment.
We often use a pattern like <hostname>(:<port>) to create uniqueness at the host and application levels, but this is up to you.
* Any entity must contain an ID that is unique within your ZMON deployment. We often use a pattern like ``<hostname>(:<port>)`` to create uniqueness at the host and application levels, but this is up to you.
Copy link
Contributor

Choose a reason for hiding this comment

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

Are you sure those render properly?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

now they do... I guess an empty line was missing

* Any entity must contain a type which describes the kind of entity, like an object class.

At the check execution we bind entity properties as default values to the functions executed, e.g. the IP gets used for relative ``http()`` requests.

Expand All @@ -29,7 +29,7 @@ Generally, ZMON entity is a set of properties that can be represented as a multi
"oneMoreProperty":"foo",
"nestedProperty": {
"subProperty1": "foo",
"subProperty2": "bar",
"subProperty2": "bar",
}
}
2 notes here to keep in mind:
Expand Down