Packages:
Package v1alpha1 contains API Schema definitions for the dashboards v1alpha1 API group
Resource Types:(Appears on: Data)
Apm is the set of metric parameters used for defining the data to plot in the widget
| Field | Description |
|---|---|
sinceSecondsint |
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 |
facetstring |
optional |
order_bystring |
optional |
DashboardBody is the Schema for the dashboards API
| Field | Description | ||||
|---|---|---|---|---|---|
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||
specDashboardSpec |
|
||||
statusStatus |
(Appears on: Dashboard)
DashboardSpec defines the desired state of DashboardBody
| Field | Description |
|---|---|
titlestring |
The name of the dashboard that will be created in New Relic |
widgets[]Widget |
A list of widgets to add to the dashboard |
(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 |
|---|---|
sourcestring |
optional
The text shown on the widget. Use in conjunction with visualization: markdown |
nrqlstring |
optional
The NRQL query used which defines the data to plot in the widget |
apmApm |
optional
The APM metric parameters which defines the data to plot in the widget. |
(Appears on: Apm)
Metric is the name of the metric as shown in Data Explorer
| Field | Description |
|---|---|
namestring |
Name of the metric |
values[]string |
List of metric values to plot. The available values will depend on the metric you choose. |
(Appears on: DashboardSpec)
Widget defines the widget parameters
For more details, refer to the official New Relic documentation
| Field | Description |
|---|---|
titlestring |
The title of the widget created in New Relic |
visualizationstring |
Visualization type to use for the widget. |
notesstring |
Notes to add to the widget |
dataData |
The data to plot on the widget |
layoutgithub.com/personio/newrelic-alert-manager/pkg/dashboards/domain/widget.Layout |
Defines the layout of the widget within the dashboard |
Package v1alpha1 contains API Schema definitions for the io v1alpha1 API group
Resource Types:(Appears on: EmailNotificationChannel, OpsgenieNotificationChannel, SlackNotificationChannel)
| Field | Description |
|---|---|
statusNotificationChannelStatus |
AlertPolicy is the Schema for the newrelicalertpolicies API
| Field | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||
specAlertPolicySpec |
|
||||||||||
statusStatus |
(Appears on: AlertPolicy)
AlertPolicySpec defines the desired state of AlertPolicy. Detailed parameter description can be found on the official New Relic documentation
| Field | Description |
|---|---|
namestring |
The name of the alert policy that will be created in New Relic |
incident_preferencestring |
The incident preference defines when incident should be created. |
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 |
(Appears on: AlertPolicySpec)
| Field | Description |
|---|---|
namestring |
The name of the alert condition that will be created in New Relic |
typestring |
The type of the metric to monitor. Should be one of: |
enabledbool |
optional
default: true |
conditionScopestring |
optional |
entities[]string |
A list of application names from APM to monitor |
violationCloseTimerint |
optional |
runbookUrlstring |
optional |
metricstring |
The APM metric to monitor. Different metrics can be applied depending on the condition type. |
alertThresholdThreshold |
Once the alertThreshold is breached, a critical incident will be generated |
warningThresholdThreshold |
optional
Once the warningThreshold is breached, a warning will be generated |
userDefinedUserDefined |
optional
Used for tracking a user defined custom metric |
EmailNotificationChannel is the Schema for the EmailNotificationChannels API
| Field | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
AbstractNotificationChannelAbstractNotificationChannel |
(Members of |
||||||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||
specEmailNotificationChannelSpec |
|
(Appears on: EmailNotificationChannel)
EmailNotificationChannelSpec defines the desired state of EmailNotificationChannel
| Field | Description |
|---|---|
namestring |
The name of the notification channel created in New Relic |
recipientsstring |
A comma-separated value of emails |
includeJsonAttachmentbool |
optional
default: false Include JSON attachment with the notification |
policySelectork8s.io/apimachinery/pkg/labels.Set |
A label selector defining the alert policies covered by the notification channel |
(Appears on: NrqlCondition)
| Field | Description |
|---|---|
expirationDurationSecondsint |
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 |
openViolationOnExpirationbool |
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 |
closeViolationsOnExpirationbool |
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 |
(Appears on: AlertPolicySpec)
| Field | Description |
|---|---|
namestring |
The name of the infra condition that will be created in New Relic |
comparisonstring |
Available options are: |
alertThresholdInfraThreshold |
Once the alertThreshold is breached, a critical incident will be generated |
warningThresholdInfraThreshold |
optional
Once the warningThreshold is breached, a warning will be generated |
enabledbool |
optional
default: true |
eventTypestring |
optional
Leave this parameter empty when creating conditions based on data from an integration provider
For more information, please refer to the |
integrationProviderstring |
When setting up alerts on integrations, specify the corresponding integration provider. |
runbookUrlstring |
optional |
selectValuestring |
The attribute name from the Event sample or Integration provider which identifies the metric to be tracked.
Examples for Sqs include |
violationCloseTimerint |
optional |
whereClausestring |
An expression used for filtering data from the IntegrationProvider |
(Appears on: InfraCondition)
| Field | Description |
|---|---|
timeFunctionstring |
Defines when the threshold should be considered as breached. |
valueint |
|
durationMinutesint |
For how long the violation should be active before an incident is triggered |
(Appears on: AbstractNotificationChannel)
NotificationChannelStatus defines the observed state of NotificationChannel
| Field | Description |
|---|---|
StatusStatus |
(Members of |
newrelicConfigVersionstring |
(Appears on: AlertPolicySpec)
| Field | Description |
|---|---|
namestring |
The name of the nrql policy that will be created in New Relic |
enabledbool |
optional
default: true |
querystring |
The NRQL query associated with the condition |
sinceMinutesint |
optional
Defines the |
valueFunctionstring |
Available options are: |
alertThresholdThreshold |
Once the alertThreshold is breached, a critical incident will be generated |
warningThresholdThreshold |
optional
Once the warningThreshold is breached, a warning will be generated |
runbookUrlstring |
optional |
signalSignal |
optional
Used to specify signal properties for missing data |
expirationExpiration |
optional
Used to define actions on signal expiration |
NotificationChannel is the Schema for the OpsgenieNotificationChannels API
| Field | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
AbstractNotificationChannelAbstractNotificationChannel |
(Members of |
||||||||||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||
specOpsgenieNotificationChannelSpec |
|
(Appears on: OpsgenieNotificationChannel)
OpsgenieNotificationChannelSpec defines the desired state of NotificationChannel
| Field | Description |
|---|---|
namestring |
The name of the notification channel created in New Relic |
api_keystring |
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 |
policySelectork8s.io/apimachinery/pkg/labels.Set |
A label selector defining the alert policies covered by the notification channel |
(Appears on: NrqlCondition)
| Field | Description |
|---|---|
aggregationWindowSecondsint |
optional
Please refer to the official New Relic documentation |
evaluationOffsetint |
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 |
fillOptionstring |
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 |
fillValuestring |
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 |
NotificationChannel is the Schema for the slacknotificationchannels API
| Field | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
AbstractNotificationChannelAbstractNotificationChannel |
(Members of |
||||||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||
specSlackNotificationChannelSpec |
|
(Appears on: SlackNotificationChannel)
SlackNotificationChannelSpec defines the desired state of NotificationChannel
| Field | Description |
|---|---|
namestring |
The name of the notification channel created in New Relic |
urlstring |
optional
The Slack webhook URL. If left empty, the default URL specified when deploying the operator will be used |
channelstring |
Name of the Slack channel. Should start with |
policySelectork8s.io/apimachinery/pkg/labels.Set |
A label selector defining the alert policies covered by the notification channel |
(Appears on: ApmCondition, NrqlCondition)
| Field | Description |
|---|---|
timeFunctionstring |
Defines when the threshold should be considered as breached. |
operatorstring |
Available options are: |
valuestring |
|
durationMinutesint |
For how long the violation should be active before an incident is triggered |
(Appears on: ApmCondition)
| Field | Description |
|---|---|
metricstring |
The name of the user defined custom metric |
value_functionstring |
Available options are: |
Package v1alpha1 contains API Schema definitions for the dashboards v1alpha1 API group
Resource Types:(Appears on: AlertPolicy, Dashboard, NotificationChannelStatus)
Status defines the observed state of a New Relic resource
| Field | Description |
|---|---|
statusstring |
The value will be set to |
reasonstring |
When a policy fails to be created, the value will be set to the error message received from New Relic |
newrelicIdint64 |
The resource id in New Relic |
Generated with gen-crd-api-reference-docs
on git commit 6f936d2.