sender

Documentation

Overview

Copyright 2020 New Relic Corporation. All rights reserved. SPDX-License-Identifier: Apache-2.0

Copyright 2020 New Relic Corporation. All rights reserved. SPDX-License-Identifier: Apache-2.0

Index

• Variables
• type Client
  • func NewAutoDetectedClient(dockerAPIVersion string) (Client, error)
  • func NewClient(agentPID int) (c Client, err error)
  • func NewContainerisedClient(apiVersion string, containerID string) (c Client, err error)

Variables

var RequiredContainerIDErr = errors.New("container ID of the agent is required")

RequiredContainerIDErr is the error to return when container ID is not provided.

var RequiredPIDErr = errors.New("process PID of the agent is required")

RequiredPIDErr is the error to return when the process ID is not provided.

Types

type Client

type Client interface {
	// Notify will send a notification that will be captured by the agent which will run a handler.
	Notify(ctx context.Context, message ipc.Message) error

	// Return the identification for the notified agent.
	GetID() string
}

Client is used to notify a running agent process.

func NewAutoDetectedClient

func NewAutoDetectedClient(dockerAPIVersion string) (Client, error)

NewAutoDetectedClient will try to detect the NRIA instance type and return a notification client for it.

func NewClient

func NewClient(agentPID int) (c Client, err error)

NewClient creates a unix process based agent control client.

func NewContainerisedClient

func NewContainerisedClient(apiVersion string, containerID string) (c Client, err error)

NewContainerisedClient creates a containerised agent control client for Docker containers. Didn't use helpers.DockerClient because it'll broad the interface breaking SRP.