Skip to content

Metric instrument limit naming #2557

Open
@jack-berg

Description

@jack-berg

The metric semantic conventions has the following instrument naming recommendation:

limit - an instrument that measures the constant, known total amount of something should be called entity.limit. For example, system.memory.limit for the total amount of memory on a system.

The java runtime memory semantic conventions has the following instruments:

  • process.runtime.jvm.memory.max
  • process.runtime.jvm.memory.init

The *.max instrument arguably should be renamed to *.limit to align with the naming recommendation. An argument to keep it as is that the idea of max memory is entrenched in java vernacular - renaming it to limit may be surprising.

Separately, instruments that have a max often have something like a minimum value as well. In the case of java memory, its *.init. The naming recommendation of limit doesn't neatly accommodate instruments with a min.

To account for this, we could change the naming recommendation to upper_limit, and include a corresponding lower_limit for symmetry.

Metadata

Metadata

Assignees

Labels

area:semantic-conventionsRelated to semantic conventionsspec:metricsRelated to the specification/metrics directory

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions