package
0.0.0-20240926082949-8d5c7bc77ec5
Repository: https://github.com/openshift/configuration-anomaly-detection.git
Documentation: pkg.go.dev

# Packages

Package pdmock is a generated GoMock package.

# Functions

GetPDClient will retrieve the PagerDuty from the 'pagerduty' package.
NewWithToken initializes a new SdkClient The token can be created using the docs https://support.pagerduty.com/docs/api-access-keys#section-generate-a-user-token-rest-api-key.

# Constants

CADEmailAddress is the email address for the 'Configuration-Anomaly-Detection' PagerDuty User.
CADIntegrationName is the name of the PD integration used to escalate alerts to Primary.
IncidentEscalated is an incident event type.
IncidentReopened is an incident event type.
IncidentResolved is an incident event type.
IncidentTriggered is an incident event type.
InvalidInputParamsErrorCode is exposed from the PagerDuty's API error response, used to distinguish between different error codes.

# Structs

AlertDetails exposes the required info we need from an alert.
CreateEventError wraps the errors returned when failing to create a PagerDuty event.
FileNotFoundError wraps the filesystem NotFound Error.
IncidentData represents the data contained in an incident.
IncidentNotFoundError wraps the PagerDuty not found error while adding notes to an incident.
IntegrationNotFoundError wraps the errors returned when a PagerDuty service's integration cannot be found.
InvalidInputParamsError wraps the PagerDuty Invalid parameters error TODO: the API also returns any other error in here, if this persists, think on renaming to "ClientMisconfiguration".
InvalidTokenError wraps the PagerDuty token invalid error.
NewAlert is a type for alerts to create on pagerduty.
NewAlertCustomDetails is a format for the alert details shown in the pagerduty incident.
SdkClient will hold all the required fields for any SdkClient Operation.
ServiceNotFoundError wraps the errors returned when PagerDuty services cannot be retrieved.
UnmarshalError wraps JSON's json.SyntaxError.

# Interfaces

Client is the interface exposing pagerduty functions.