Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Key elements of the measurement:

  • Define the The attribute and the entity to measure.
  • Define the The important scope or scopes (see below) in  in which this kind of entity exists, and in which each meter will measure the attribute.
  • Identify the conditions (see below) that The conditions that govern whether to measure the attribute and how to report the measurements.

See below for guidance about each element.

Audience focus. Define the measurement entirely in terms that the audience understands. Define the measurement in such a way that the audience can easily understand which measurements relate most directly to their current goals, questions, and challenges.

Rationale. Answering Defining these questions elements will help you:

  • Name and describe the meter.
  • Define the units in which the meter reports measurements.
  • Identify tags to add to the meter.
  • Identify and evaluate potential instrumentation sites.
  • Ensure that measurements are accurate and meaningful, rather than merely easy to measure.

Define the Attribute and the Entity to Measure

TBD:

  • Attribute
  • Entity
  • Identify the operations, events, or conditions that cause the attribute to change.

Define the Scope of the Measurement

When you define a measurement, clearly identify the key scope or scopes in which the measurement is made. Look for two common kinds of scopes:

  • The entity about which the measurement is made.
  • The boundaries within which the measurement is made.

Each meter measures some attribute of some entity. Identify and describe the entity and the attribute.

The The entity. Each measurement is about some entity. Each meter measures some attribute of that entity or on behalf of that entity or in relation to that entity.

Example: Each geode.cache.entries gauge reports the number of entries in a particular region. The measurement is about that region. The gauge includes a region tag that identifies which region it measures.

The attribute. 

  • Identify the attribute to measure.
  • Identify the kind of entity for which
  • Identify the operations, events, or conditions that cause the attribute to change.

Define the Scope of the Measurement

When you define a measurement, clearly identify the key scope or scopes in which the measurement is made. Look for two common kinds of scopes:

  • The entity about which the measurement is made.
  • The boundaries within which the measurement is made.

Boundaries. Each meter measures within one or more boundaries of interest to your audience.

...