metric-schema-api.yml

types:
  definitions:
    default-package: com.palantir.metric.schema
    objects:
      MetricSchema:
        fields:
          namespaces: map<string, MetricNamespace>
          options:
            docs: >
              Additional pieces of information that do not change the overall declaration,
              but may affect the way it is handled in a particular context. For example,
              `javaPackage` will determine the package of the generated classes.
            type: map<string, string>
      MetricNamespace:
        fields:
          shortName:
            docs: A short name describing the metrics. Used to construct the name of the generated utility class.
            type: optional<string>
          docs: Documentation
          tags: list<TagDefinition>
          metrics:
            type: map<string,MetricDefinition>
      MetricDefinition:
        fields:
          type: MetricType
          tags: set<string>
          tagDefinitions: list<TagDefinition>
          docs: Documentation
      MetricType:
        values:
          - COUNTER
          - GAUGE
          - METER
          - TIMER
          - HISTOGRAM
      Documentation:
        docs: Documentation describing an associated component. Markdown syntax may be used.
        alias: string
      TagDefinition:
        fields:
          name: string
          docs: optional<Documentation>
          values: set<TagValue>
      TagValue:
        fields:
          value: string
          docs: optional<Documentation>