Skip to content

[ecs-metrics] docs: add guideline regarding units in names #481

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.

Sign up for GitHub

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

Merged
axw merged 1 commit into from
Jun 12, 2019
Merged

[ecs-metrics] docs: add guideline regarding units in names #481

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions docs/using-guidelines.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,9 @@ Each {ecs} <<ecs-field-reference,field>> in a table is identified as core or ext
** Exceptions can be made, when the name used for the concept is too strongly
in favor of the abbreviation.
Example: `ip` fields, or field sets such as `os`, `geo`.

* *Avoid declaring units*
** So that we don't conflict with aspirations in https://github.com/elastic/elasticsearch/issues/31244,
avoid specifying units such as "bytes" or "sec". Until Elasticsearch and/or Kibana have
native support for such units, we will either rely on documentation or hard-code knowledge of
units for specific fields into Kibana.