Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 

README.md

Packages:

dashboards.newrelic.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the dashboards v1alpha1 API group

Resource Types:

    Apm

    (Appears on: Data)

    Apm is the set of metric parameters used for defining the data to plot in the widget

    Field Description
    sinceSeconds
    int

    The time frame in seconds

    entities
    []string

    A list of application names for which to get the metric

    metrics
    []Metric

    A list of metrics to use

    facet
    string
    optional
    order_by
    string
    optional

    Dashboard

    DashboardBody is the Schema for the dashboards API

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    DashboardSpec


    title
    string

    The name of the dashboard that will be created in New Relic

    widgets
    []Widget

    A list of widgets to add to the dashboard

    status
    Status

    DashboardSpec

    (Appears on: Dashboard)

    DashboardSpec defines the desired state of DashboardBody

    Field Description
    title
    string

    The name of the dashboard that will be created in New Relic

    widgets
    []Widget

    A list of widgets to add to the dashboard

    Data

    (Appears on: Widget)

    Data represents the data to plot inside the widget.
    Exactly one of Source, Nrql or ApmMetric should be specified.

    Leave all fields empty if you want to plot the application breakdown data,
    also present in the main widget that comes with the default application dashboard.
    For more information refer to the official New Relic documentation

    Field Description
    source
    string
    optional

    The text shown on the widget. Use in conjunction with visualization: markdown

    nrql
    string
    optional

    The NRQL query used which defines the data to plot in the widget

    apm
    Apm
    optional

    The APM metric parameters which defines the data to plot in the widget.
    When using an APM metric for the data, visualization should be set to either metric_line_chart or application_breakdown.

    Metric

    (Appears on: Apm)

    Metric is the name of the metric as shown in Data Explorer

    Field Description
    name
    string

    Name of the metric

    values
    []string

    List of metric values to plot. The available values will depend on the metric you choose.
    Check the Data Explorer in New Relic to find out which values are available for which metrics.

    Widget

    (Appears on: DashboardSpec)

    Widget defines the widget parameters
    For more details, refer to the official New Relic documentation

    Field Description
    title
    string

    The title of the widget created in New Relic

    visualization
    string

    Visualization type to use for the widget.
    Available options are:
    - application_breakdown
    - attribute_sheet
    - background_breakdown
    - billboard
    - billboard_comparison
    - comparison_line_chart
    - event_table
    - facet_bar_chart
    - facet_pie_chart
    - facet_table
    - faceted_area_chart
    - faceted_line_chart
    - funnel
    - gauge
    - heatmap
    - histogram
    - json
    - line_chart
    - markdown
    - list
    - metric_line_chart (used for apm metrics)

    notes
    string

    Notes to add to the widget

    data
    Data

    The data to plot on the widget

    layout
    github.com/personio/newrelic-alert-manager/pkg/dashboards/domain/widget.Layout

    Defines the layout of the widget within the dashboard


    alerts.newrelic.io/v1alpha1

    Package v1alpha1 contains API Schema definitions for the io v1alpha1 API group

    Resource Types:

      AbstractNotificationChannel

      (Appears on: EmailNotificationChannel, OpsgenieNotificationChannel, SlackNotificationChannel)

      Field Description
      status
      NotificationChannelStatus

      AlertPolicy

      AlertPolicy is the Schema for the newrelicalertpolicies API

      Field Description
      metadata
      Kubernetes meta/v1.ObjectMeta
      Refer to the Kubernetes API documentation for the fields of the metadata field.
      spec
      AlertPolicySpec


      name
      string

      The name of the alert policy that will be created in New Relic

      incident_preference
      string

      The incident preference defines when incident should be created.
      Can be one of:
      - per_policy
      - per_condition
      - per_condition_and_target

      apmConditions
      []ApmCondition
      optional

      A list of APM alert conditions to attach to the policy

      nrqlConditions
      []NrqlCondition
      optional

      A list of NRQL alert conditions to attach to the policy

      infraConditions
      []InfraCondition
      optional

      A list of Infrastructure alert conditions to attach to the policy

      status
      Status

      AlertPolicySpec

      (Appears on: AlertPolicy)

      AlertPolicySpec defines the desired state of AlertPolicy. Detailed parameter description can be found on the official New Relic documentation

      Field Description
      name
      string

      The name of the alert policy that will be created in New Relic

      incident_preference
      string

      The incident preference defines when incident should be created.
      Can be one of:
      - per_policy
      - per_condition
      - per_condition_and_target

      apmConditions
      []ApmCondition
      optional

      A list of APM alert conditions to attach to the policy

      nrqlConditions
      []NrqlCondition
      optional

      A list of NRQL alert conditions to attach to the policy

      infraConditions
      []InfraCondition
      optional

      A list of Infrastructure alert conditions to attach to the policy

      ApmCondition

      (Appears on: AlertPolicySpec)

      Field Description
      name
      string

      The name of the alert condition that will be created in New Relic

      type
      string

      The type of the metric to monitor. Should be one of:
      - apm_app_metric
      - apm_kt_metric
      - apm_jvm_metric
      - browser_metric
      - mobile_metric
      Please refer to the Alerts conditions section in the New Relic documentation for more details

      enabled
      bool
      optional

      default: true

      conditionScope
      string
      optional
      entities
      []string

      A list of application names from APM to monitor

      violationCloseTimer
      int
      optional
      runbookUrl
      string
      optional
      metric
      string

      The APM metric to monitor. Different metrics can be applied depending on the condition type.
      An example of a valid (type, metric) combination is (apm_app_metric, apdex).
      Please refer to the Alerts conditions section in the New Relic documentation for more details

      alertThreshold
      Threshold

      Once the alertThreshold is breached, a critical incident will be generated

      warningThreshold
      Threshold
      optional

      Once the warningThreshold is breached, a warning will be generated

      userDefined
      UserDefined
      optional

      Used for tracking a user defined custom metric
      For more information, please refer to the New Relic documentation

      ChannelFactory

      EmailNotificationChannel

      EmailNotificationChannel is the Schema for the EmailNotificationChannels API

      Field Description
      AbstractNotificationChannel
      AbstractNotificationChannel

      (Members of AbstractNotificationChannel are embedded into this type.)

      metadata
      Kubernetes meta/v1.ObjectMeta
      Refer to the Kubernetes API documentation for the fields of the metadata field.
      spec
      EmailNotificationChannelSpec


      name
      string

      The name of the notification channel created in New Relic

      recipients
      string

      A comma-separated value of emails

      includeJsonAttachment
      bool
      optional

      default: false

      Include JSON attachment with the notification

      policySelector
      k8s.io/apimachinery/pkg/labels.Set

      A label selector defining the alert policies covered by the notification channel

      EmailNotificationChannelSpec

      (Appears on: EmailNotificationChannel)

      EmailNotificationChannelSpec defines the desired state of EmailNotificationChannel

      Field Description
      name
      string

      The name of the notification channel created in New Relic

      recipients
      string

      A comma-separated value of emails

      includeJsonAttachment
      bool
      optional

      default: false

      Include JSON attachment with the notification

      policySelector
      k8s.io/apimachinery/pkg/labels.Set

      A label selector defining the alert policies covered by the notification channel

      Expiration

      (Appears on: NrqlCondition)

      Field Description
      expirationDurationSeconds
      int
      optional

      How long to wait, in seconds, after the last data point is received by our platform before considering the signal as lost. For more information, please refer to the official New Relic documentation

      openViolationOnExpiration
      bool
      optional

      When true, this closes all currently open violations when no signal is heard within the expiration_duration time. For more information, please refer to the official New Relic documentation

      closeViolationsOnExpiration
      bool
      optional

      When true, this opens a loss of signal violation when no signal within the expiration_duration time. For more information, please refer to the official New Relic documentation

      InfraCondition

      (Appears on: AlertPolicySpec)

      Field Description
      name
      string

      The name of the infra condition that will be created in New Relic

      comparison
      string

      Available options are:
      - above
      - below
      - equal

      alertThreshold
      InfraThreshold

      Once the alertThreshold is breached, a critical incident will be generated

      warningThreshold
      InfraThreshold
      optional

      Once the warningThreshold is breached, a warning will be generated

      enabled
      bool
      optional

      default: true

      eventType
      string
      optional

      Leave this parameter empty when creating conditions based on data from an integration provider For more information, please refer to the event_type field in the official New Relic documentation

      integrationProvider
      string

      When setting up alerts on integrations, specify the corresponding integration provider.
      Examples can include SqsQueue, Kubernetes, RdsDbInstance etc.
      For more information, please refer to the integration_provider field in the official New Relic documentation

      runbookUrl
      string
      optional
      selectValue
      string

      The attribute name from the Event sample or Integration provider which identifies the metric to be tracked. Examples for Sqs include provider.approximateAgeOfOldestMessage.Average and provider.numberOfEmptyReceives.Average. For more information, please refer to the select_value field in the official New Relic documentation

      violationCloseTimer
      int
      optional
      whereClause
      string

      An expression used for filtering data from the IntegrationProvider

      InfraThreshold

      (Appears on: InfraCondition)

      Field Description
      timeFunction
      string

      Defines when the threshold should be considered as breached.
      Available options are:
      - all - all data points are in violation within the given period
      - any - at least one data point is in violation within the given period

      value
      int
      durationMinutes
      int

      For how long the violation should be active before an incident is triggered

      NotificationChannel

      NotificationChannelStatus

      (Appears on: AbstractNotificationChannel)

      NotificationChannelStatus defines the observed state of NotificationChannel

      Field Description
      Status
      Status

      (Members of Status are embedded into this type.)

      newrelicConfigVersion
      string

      NrqlCondition

      (Appears on: AlertPolicySpec)

      Field Description
      name
      string

      The name of the nrql policy that will be created in New Relic

      enabled
      bool
      optional

      default: true

      query
      string

      The NRQL query associated with the condition

      sinceMinutes
      int
      optional

      Defines the SINCE clause in the NRQL query

      valueFunction
      string

      Available options are:
      - single_value
      - sum
      For more information, please refer to the official New Relic documentation

      alertThreshold
      Threshold

      Once the alertThreshold is breached, a critical incident will be generated

      warningThreshold
      Threshold
      optional

      Once the warningThreshold is breached, a warning will be generated

      runbookUrl
      string
      optional
      signal
      Signal
      optional

      Used to specify signal properties for missing data

      expiration
      Expiration
      optional

      Used to define actions on signal expiration

      OpsgenieNotificationChannel

      NotificationChannel is the Schema for the OpsgenieNotificationChannels API

      Field Description
      AbstractNotificationChannel
      AbstractNotificationChannel

      (Members of AbstractNotificationChannel are embedded into this type.)

      metadata
      Kubernetes meta/v1.ObjectMeta
      Refer to the Kubernetes API documentation for the fields of the metadata field.
      spec
      OpsgenieNotificationChannelSpec


      name
      string

      The name of the notification channel created in New Relic

      api_key
      string
      optional

      The Opsgenie API Key. If left empty, the default API key specified when deploying the operator will be used

      teams
      []string
      optional

      A list of teams

      tags
      []string
      optional

      A list of tags

      recipients
      []string
      optional

      A comma-separated value of emails

      policySelector
      k8s.io/apimachinery/pkg/labels.Set

      A label selector defining the alert policies covered by the notification channel

      OpsgenieNotificationChannelSpec

      (Appears on: OpsgenieNotificationChannel)

      OpsgenieNotificationChannelSpec defines the desired state of NotificationChannel

      Field Description
      name
      string

      The name of the notification channel created in New Relic

      api_key
      string
      optional

      The Opsgenie API Key. If left empty, the default API key specified when deploying the operator will be used

      teams
      []string
      optional

      A list of teams

      tags
      []string
      optional

      A list of tags

      recipients
      []string
      optional

      A comma-separated value of emails

      policySelector
      k8s.io/apimachinery/pkg/labels.Set

      A label selector defining the alert policies covered by the notification channel

      Signal

      (Appears on: NrqlCondition)

      Field Description
      aggregationWindowSeconds
      int
      optional

      Please refer to the official New Relic documentation

      evaluationOffset
      int
      optional

      The offset is how long we wait for late data before evaluating each aggregation window For additional information, please refer to the official New Relic documentation

      fillOption
      string
      optional

      For sporadic data, you can avoid false alerts by filling the gaps (empty windows) with synthetic data. The default is None. For additional information, please refer to the official New Relic documentation

      fillValue
      string
      optional

      This is the value used by the fill_option custom value. The default is 0. For additional information, please refer to the official New Relic documentation

      SlackNotificationChannel

      NotificationChannel is the Schema for the slacknotificationchannels API

      Field Description
      AbstractNotificationChannel
      AbstractNotificationChannel

      (Members of AbstractNotificationChannel are embedded into this type.)

      metadata
      Kubernetes meta/v1.ObjectMeta
      Refer to the Kubernetes API documentation for the fields of the metadata field.
      spec
      SlackNotificationChannelSpec


      name
      string

      The name of the notification channel created in New Relic

      url
      string
      optional

      The Slack webhook URL. If left empty, the default URL specified when deploying the operator will be used

      channel
      string

      Name of the Slack channel. Should start with #

      policySelector
      k8s.io/apimachinery/pkg/labels.Set

      A label selector defining the alert policies covered by the notification channel

      SlackNotificationChannelSpec

      (Appears on: SlackNotificationChannel)

      SlackNotificationChannelSpec defines the desired state of NotificationChannel

      Field Description
      name
      string

      The name of the notification channel created in New Relic

      url
      string
      optional

      The Slack webhook URL. If left empty, the default URL specified when deploying the operator will be used

      channel
      string

      Name of the Slack channel. Should start with #

      policySelector
      k8s.io/apimachinery/pkg/labels.Set

      A label selector defining the alert policies covered by the notification channel

      Threshold

      (Appears on: ApmCondition, NrqlCondition)

      Field Description
      timeFunction
      string

      Defines when the threshold should be considered as breached.
      Available options are:
      * all - all data points are in violation within the given period
      * any - at least one data point is in violation within the given period
      For more information, please refer to the official New Relic documentation

      operator
      string

      Available options are:
      - above
      - below
      - equal

      value
      string
      durationMinutes
      int

      For how long the violation should be active before an incident is triggered
      For more information, please refer to the official New Relic documentation

      UserDefined

      (Appears on: ApmCondition)

      Field Description
      metric
      string

      The name of the user defined custom metric

      value_function
      string

      Available options are:
      - average
      - min
      - max
      - total
      - sample_size
      For more information, please refer to the official New Relic documentation


      common.newrelic.io/v1alpha1

      Package v1alpha1 contains API Schema definitions for the dashboards v1alpha1 API group

      Resource Types:

        Status

        (Appears on: AlertPolicy, Dashboard, NotificationChannelStatus)

        Status defines the observed state of a New Relic resource

        Field Description
        status
        string

        The value will be set to Ready once the policy has been created in New Relic

        reason
        string

        When a policy fails to be created, the value will be set to the error message received from New Relic

        newrelicId
        int64

        The resource id in New Relic


        Generated with gen-crd-api-reference-docs on git commit 6f936d2.