notifications

README

README

This package contains the notifications client written in the Go programming language. The notifications client is used by Go services or other Go code to communicate with the EdgeX support-notifications microservice (regardless of underlying implemenation type) by sending REST requests to the service's API endpoints.

How To Use

To use the support-notifications client package you first need to import the library into your project:

import "github.com/edgexfoundry/go-mod-core-contracts/clients/notifications"

To send a notification you first need to get a NotificationsClient and then send a Notification struct:

		notification := notifications.Notification{
			Slug:        configuration.NotificationsSlug + strconv.FormatInt((time.Now().UnixNano()/int64(time.Millisecond)), 10),
			Content:     configuration.NotificationContent + name + "-" + string(action),
			Category:    notifications.SW_HEALTH,
			Description: configuration.NotificationDescription,
			Labels:      []string{configuration.NotificationLabel},
			Sender:      configuration.NotificationSender,
			Severity:    notifications.NORMAL,
		}

		notifications.GetNotificationsClient().SendNotification(notification)

This will send the notification to the notifications service.

Documentation

Overview

Package notifications provides a client for integrating with the support-notifications service.

Index

• type CategoryEnum
• type Notification
• type NotificationsClient
  • func NewNotificationsClient(params types.EndpointParams, m clients.Endpointer) NotificationsClient
• type SeverityEnum
• type StatusEnum

Types

type CategoryEnum

type CategoryEnum string

const (
	SECURITY  CategoryEnum = "SECURITY"
	HW_HEALTH CategoryEnum = "HW_HEALTH"
	SW_HEALTH CategoryEnum = "SW_HEALTH"
)

type Notification

type Notification struct {
	Id          string       `json:"id,omitempty"`          // Generated by the system, users can ignore
	Slug        string       `json:"slug"`                  // A meaningful identifier provided by client
	Sender      string       `json:"sender"`                // Indicates the sender of a notification -- possibly a service name or email address
	Category    CategoryEnum `json:"category"`              // Allows for categorization of notifications
	Severity    SeverityEnum `json:"severity"`              // Denotes the severity of a notification
	Content     string       `json:"content"`               // Content contains the body of the notification
	Description string       `json:"description,omitempty"` // Description content for the notification
	Status      StatusEnum   `json:"status,omitempty"`      // Status reflects a simple workflow assignment for the notification
	Labels      []string     `json:"labels,omitempty"`      // Labels allows the notification to be further described/classified
	Created     int          `json:"created,omitempty"`     // The creation timestamp
	Modified    int          `json:"modified,omitempty"`    // The last modification timestamp
}

Notification defines the structure of data being sent.

type NotificationsClient

type NotificationsClient interface {
	// SendNotification sends a notification.
	SendNotification(n Notification, ctx context.Context) error
}

NotificationsClient defines the interface for interactions with the EdgeX Foundry support-notifications service.

func NewNotificationsClient

func NewNotificationsClient(params types.EndpointParams, m clients.Endpointer) NotificationsClient

NewNotificationsClient creates an instance of NotificationsClient

type SeverityEnum

type SeverityEnum string

const (
	CRITICAL SeverityEnum = "CRITICAL"
	NORMAL   SeverityEnum = "NORMAL"
)

type StatusEnum

type StatusEnum string

const (
	NEW       StatusEnum = "NEW"
	PROCESSED StatusEnum = "PROCESSED"
	ESCALATED StatusEnum = "ESCALATED"
)