hunfabric/modules/project/schemas/observability.schema.md

Observability Schema

Properties

additional properties: false

• alerts: reference(alerts)
• logging_metrics: reference(logging_metrics)
• notification_channels: reference(notification_channels)

Definitions

• alerts: object
  additional properties: false
  • ^[a-zA-Z0-9-]+$: object
    additional properties: false
    • ⁺combiner: string
    • display_name: string
    • enabled: boolean
    • notification_channels: array
      • items: string
    • severity: string
    • user_labels: object
      additional properties: string
    • alert_strategy: object
      additional properties: false
      • auto_close: string
      • notification_prompts: string
      • notification_rate_limit: object
        additional properties: false
        • period: string
      • notification_channel_strategy: object
        additional properties: false
        • notification_channel_names: array
          • items: string
        • renotify_interval: string
    • conditions: array
      • items: reference(condition)
    • documentation: object
      additional properties: false
      • content: string
      • mime_type: string
      • subject: string
      • links: array
        • items: object
          additional properties: false
          • display_name: string
          • url: string
• logging_metrics: object
  additional properties: false
  • ^[a-zA-Z0-9-]+$: object
    additional properties: false
    • ⁺filter: string
    • bucket_name: string
    • description: string
    • disabled: boolean
    • label_extractors: object
      additional properties: string
    • value_extractor: string
    • bucket_options: object
      additional properties: false
      • explicit_buckets: object
        additional properties: false
        • bounds: array
          • items: number
      • exponential_buckets: object
        additional properties: false
        • num_finite_buckets: number
        • growth_factor: number
        • scale: number
      • linear_buckets: object
        additional properties: false
        • num_finite_buckets: number
        • width: number
        • offset: number
    • metric_descriptor: object
      additional properties: false
      • ⁺metric_kind: string
      • ⁺value_type: string
      • display_name: string
      • unit: string
      • labels: array
        • items: object
          additional properties: false
          • ⁺key: string
          • description: string
          • value_type: string
• notification_channels: object
  additional properties: false
  • ^[a-zA-Z0-9-]+$: object
    additional properties: false
    • ⁺type: string
    • description: string
    • display_name: string
    • enabled: boolean
    • labels: object
      additional properties: string
    • user_labels: object
      additional properties: string
    • sensitive_labels: object
      additional properties: false
      • auth_token: string
      • password: string
      • service_key: string
• condition: object
  additional properties: false
  • ⁺display_name: string
  • condition_absent: reference(absent_condition)
  • condition_matched_log: reference(matched_log_condition)
  • condition_monitoring_query_language: reference(monitoring_query_condition)
  • condition_prometheus_query_language: reference(prometheus_query_condition)
  • condition_threshold: reference(threshold_condition)
• absent_condition: object
  additional properties: false
  • ⁺duration: string
  • filter: string
  • aggregations: reference(aggregations)
  • trigger: reference(trigger)
• matched_log_condition: object
  additional properties: false
  • ⁺filter: string
  • label_extractors: object
    additional properties: string
• monitoring_query_condition: object
  additional properties: false
  • ⁺duration: string
  • ⁺query: string
  • evaluation_missing_data: string
  • trigger: reference(trigger)
• prometheus_query_condition: object
  additional properties: false
  • ⁺query: string
  • alert_rule: string
  • disable_metric_validation: boolean
  • duration: string
  • evaluation_interval: string
  • labels: object
    additional properties: string
  • rule_group: string
• threshold_condition: object
  additional properties: false
  • ⁺comparison: string
  • ⁺duration: string
  • denominator_filter: string
  • evaluation_missing_data: string
  • filter: string
  • threshold_value: number
  • aggregations: reference(aggregations)
  • denominator_aggregations: reference(aggregations)
  • forecast_options: object
    additional properties: false
    • forecast_horizon: string
  • trigger: reference(trigger)
• aggregations: array
  • items: object
    additional properties: false
    • per_series_aligner: string
    • group_by_fields: array
      • items: string
    • cross_series_reducer: string
    • alignment_period: string
• trigger: object
  additional properties: false
  • count: number
  • percent: number