protobufs

package
v0.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 26, 2024 License: Apache-2.0 Imports: 4 Imported by: 17

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	AgentToServerFlags_name = map[int32]string{
		0: "AgentToServerFlags_Unspecified",
		1: "AgentToServerFlags_RequestInstanceUid",
	}
	AgentToServerFlags_value = map[string]int32{
		"AgentToServerFlags_Unspecified":        0,
		"AgentToServerFlags_RequestInstanceUid": 1,
	}
)

Enum value maps for AgentToServerFlags.

View Source
var (
	ServerToAgentFlags_name = map[int32]string{
		0: "ServerToAgentFlags_Unspecified",
		1: "ServerToAgentFlags_ReportFullState",
	}
	ServerToAgentFlags_value = map[string]int32{
		"ServerToAgentFlags_Unspecified":     0,
		"ServerToAgentFlags_ReportFullState": 1,
	}
)

Enum value maps for ServerToAgentFlags.

View Source
var (
	ServerCapabilities_name = map[int32]string{
		0:  "ServerCapabilities_Unspecified",
		1:  "ServerCapabilities_AcceptsStatus",
		2:  "ServerCapabilities_OffersRemoteConfig",
		4:  "ServerCapabilities_AcceptsEffectiveConfig",
		8:  "ServerCapabilities_OffersPackages",
		16: "ServerCapabilities_AcceptsPackagesStatus",
		32: "ServerCapabilities_OffersConnectionSettings",
		64: "ServerCapabilities_AcceptsConnectionSettingsRequest",
	}
	ServerCapabilities_value = map[string]int32{
		"ServerCapabilities_Unspecified":                      0,
		"ServerCapabilities_AcceptsStatus":                    1,
		"ServerCapabilities_OffersRemoteConfig":               2,
		"ServerCapabilities_AcceptsEffectiveConfig":           4,
		"ServerCapabilities_OffersPackages":                   8,
		"ServerCapabilities_AcceptsPackagesStatus":            16,
		"ServerCapabilities_OffersConnectionSettings":         32,
		"ServerCapabilities_AcceptsConnectionSettingsRequest": 64,
	}
)

Enum value maps for ServerCapabilities.

View Source
var (
	PackageType_name = map[int32]string{
		0: "PackageType_TopLevel",
		1: "PackageType_Addon",
	}
	PackageType_value = map[string]int32{
		"PackageType_TopLevel": 0,
		"PackageType_Addon":    1,
	}
)

Enum value maps for PackageType.

View Source
var (
	ServerErrorResponseType_name = map[int32]string{
		0: "ServerErrorResponseType_Unknown",
		1: "ServerErrorResponseType_BadRequest",
		2: "ServerErrorResponseType_Unavailable",
	}
	ServerErrorResponseType_value = map[string]int32{
		"ServerErrorResponseType_Unknown":     0,
		"ServerErrorResponseType_BadRequest":  1,
		"ServerErrorResponseType_Unavailable": 2,
	}
)

Enum value maps for ServerErrorResponseType.

View Source
var (
	CommandType_name = map[int32]string{
		0: "CommandType_Restart",
	}
	CommandType_value = map[string]int32{
		"CommandType_Restart": 0,
	}
)

Enum value maps for CommandType.

View Source
var (
	AgentCapabilities_name = map[int32]string{
		0:    "AgentCapabilities_Unspecified",
		1:    "AgentCapabilities_ReportsStatus",
		2:    "AgentCapabilities_AcceptsRemoteConfig",
		4:    "AgentCapabilities_ReportsEffectiveConfig",
		8:    "AgentCapabilities_AcceptsPackages",
		16:   "AgentCapabilities_ReportsPackageStatuses",
		32:   "AgentCapabilities_ReportsOwnTraces",
		64:   "AgentCapabilities_ReportsOwnMetrics",
		128:  "AgentCapabilities_ReportsOwnLogs",
		256:  "AgentCapabilities_AcceptsOpAMPConnectionSettings",
		512:  "AgentCapabilities_AcceptsOtherConnectionSettings",
		1024: "AgentCapabilities_AcceptsRestartCommand",
		2048: "AgentCapabilities_ReportsHealth",
		4096: "AgentCapabilities_ReportsRemoteConfig",
	}
	AgentCapabilities_value = map[string]int32{
		"AgentCapabilities_Unspecified":                    0,
		"AgentCapabilities_ReportsStatus":                  1,
		"AgentCapabilities_AcceptsRemoteConfig":            2,
		"AgentCapabilities_ReportsEffectiveConfig":         4,
		"AgentCapabilities_AcceptsPackages":                8,
		"AgentCapabilities_ReportsPackageStatuses":         16,
		"AgentCapabilities_ReportsOwnTraces":               32,
		"AgentCapabilities_ReportsOwnMetrics":              64,
		"AgentCapabilities_ReportsOwnLogs":                 128,
		"AgentCapabilities_AcceptsOpAMPConnectionSettings": 256,
		"AgentCapabilities_AcceptsOtherConnectionSettings": 512,
		"AgentCapabilities_AcceptsRestartCommand":          1024,
		"AgentCapabilities_ReportsHealth":                  2048,
		"AgentCapabilities_ReportsRemoteConfig":            4096,
	}
)

Enum value maps for AgentCapabilities.

View Source
var (
	RemoteConfigStatuses_name = map[int32]string{
		0: "RemoteConfigStatuses_UNSET",
		1: "RemoteConfigStatuses_APPLIED",
		2: "RemoteConfigStatuses_APPLYING",
		3: "RemoteConfigStatuses_FAILED",
	}
	RemoteConfigStatuses_value = map[string]int32{
		"RemoteConfigStatuses_UNSET":    0,
		"RemoteConfigStatuses_APPLIED":  1,
		"RemoteConfigStatuses_APPLYING": 2,
		"RemoteConfigStatuses_FAILED":   3,
	}
)

Enum value maps for RemoteConfigStatuses.

View Source
var (
	PackageStatusEnum_name = map[int32]string{
		0: "PackageStatusEnum_Installed",
		1: "PackageStatusEnum_InstallPending",
		2: "PackageStatusEnum_Installing",
		3: "PackageStatusEnum_InstallFailed",
	}
	PackageStatusEnum_value = map[string]int32{
		"PackageStatusEnum_Installed":      0,
		"PackageStatusEnum_InstallPending": 1,
		"PackageStatusEnum_Installing":     2,
		"PackageStatusEnum_InstallFailed":  3,
	}
)

Enum value maps for PackageStatusEnum.

View Source
var File_anyvalue_proto protoreflect.FileDescriptor
View Source
var File_opamp_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AgentCapabilities

type AgentCapabilities int32
const (
	// The capabilities field is unspecified.
	AgentCapabilities_AgentCapabilities_Unspecified AgentCapabilities = 0
	// The Agent can report status. This bit MUST be set, since all Agents MUST
	// report status.
	AgentCapabilities_AgentCapabilities_ReportsStatus AgentCapabilities = 1
	// The Agent can accept remote configuration from the Server.
	AgentCapabilities_AgentCapabilities_AcceptsRemoteConfig AgentCapabilities = 2
	// The Agent will report EffectiveConfig in AgentToServer.
	AgentCapabilities_AgentCapabilities_ReportsEffectiveConfig AgentCapabilities = 4
	// The Agent can accept package offers.
	// Status: [Beta]
	AgentCapabilities_AgentCapabilities_AcceptsPackages AgentCapabilities = 8
	// The Agent can report package status.
	// Status: [Beta]
	AgentCapabilities_AgentCapabilities_ReportsPackageStatuses AgentCapabilities = 16
	// The Agent can report own trace to the destination specified by
	// the Server via ConnectionSettingsOffers.own_traces field.
	// Status: [Beta]
	AgentCapabilities_AgentCapabilities_ReportsOwnTraces AgentCapabilities = 32
	// The Agent can report own metrics to the destination specified by
	// the Server via ConnectionSettingsOffers.own_metrics field.
	// Status: [Beta]
	AgentCapabilities_AgentCapabilities_ReportsOwnMetrics AgentCapabilities = 64
	// The Agent can report own logs to the destination specified by
	// the Server via ConnectionSettingsOffers.own_logs field.
	// Status: [Beta]
	AgentCapabilities_AgentCapabilities_ReportsOwnLogs AgentCapabilities = 128
	// The can accept connections settings for OpAMP via
	// ConnectionSettingsOffers.opamp field.
	// Status: [Beta]
	AgentCapabilities_AgentCapabilities_AcceptsOpAMPConnectionSettings AgentCapabilities = 256
	// The can accept connections settings for other destinations via
	// ConnectionSettingsOffers.other_connections field.
	// Status: [Beta]
	AgentCapabilities_AgentCapabilities_AcceptsOtherConnectionSettings AgentCapabilities = 512
	// The Agent can accept restart requests.
	// Status: [Beta]
	AgentCapabilities_AgentCapabilities_AcceptsRestartCommand AgentCapabilities = 1024
	// The Agent will report Health via AgentToServer.health field.
	AgentCapabilities_AgentCapabilities_ReportsHealth AgentCapabilities = 2048
	// The Agent will report RemoteConfig status via AgentToServer.remote_config_status field.
	AgentCapabilities_AgentCapabilities_ReportsRemoteConfig AgentCapabilities = 4096
)

func (AgentCapabilities) Descriptor

func (AgentCapabilities) Enum

func (AgentCapabilities) EnumDescriptor deprecated

func (AgentCapabilities) EnumDescriptor() ([]byte, []int)

Deprecated: Use AgentCapabilities.Descriptor instead.

func (AgentCapabilities) Number

func (AgentCapabilities) String

func (x AgentCapabilities) String() string

func (AgentCapabilities) Type

type AgentConfigFile

type AgentConfigFile struct {

	// Config file or section body. The content, format and encoding depends on the Agent
	// type. The content_type field may optionally describe the MIME type of the body.
	Body []byte `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Optional MIME Content-Type that describes what's in the body field, for
	// example "text/yaml".
	ContentType string `protobuf:"bytes,2,opt,name=content_type,json=contentType,proto3" json:"content_type,omitempty"`
	// contains filtered or unexported fields
}

func (*AgentConfigFile) Descriptor deprecated

func (*AgentConfigFile) Descriptor() ([]byte, []int)

Deprecated: Use AgentConfigFile.ProtoReflect.Descriptor instead.

func (*AgentConfigFile) GetBody

func (x *AgentConfigFile) GetBody() []byte

func (*AgentConfigFile) GetContentType

func (x *AgentConfigFile) GetContentType() string

func (*AgentConfigFile) ProtoMessage

func (*AgentConfigFile) ProtoMessage()

func (*AgentConfigFile) ProtoReflect

func (x *AgentConfigFile) ProtoReflect() protoreflect.Message

func (*AgentConfigFile) Reset

func (x *AgentConfigFile) Reset()

func (*AgentConfigFile) String

func (x *AgentConfigFile) String() string

type AgentConfigMap

type AgentConfigMap struct {

	// Map of configs. Keys are config file names or config section names.
	// The configuration is assumed to be a collection of one or more named config files
	// or sections.
	// For agents that use a single config file or section the map SHOULD contain a single
	// entry and the key may be an empty string.
	ConfigMap map[string]*AgentConfigFile `` /* 176-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*AgentConfigMap) Descriptor deprecated

func (*AgentConfigMap) Descriptor() ([]byte, []int)

Deprecated: Use AgentConfigMap.ProtoReflect.Descriptor instead.

func (*AgentConfigMap) GetConfigMap

func (x *AgentConfigMap) GetConfigMap() map[string]*AgentConfigFile

func (*AgentConfigMap) ProtoMessage

func (*AgentConfigMap) ProtoMessage()

func (*AgentConfigMap) ProtoReflect

func (x *AgentConfigMap) ProtoReflect() protoreflect.Message

func (*AgentConfigMap) Reset

func (x *AgentConfigMap) Reset()

func (*AgentConfigMap) String

func (x *AgentConfigMap) String() string

type AgentDescription

type AgentDescription struct {

	// Attributes that identify the Agent.
	// Keys/values are according to OpenTelemetry semantic conventions, see:
	// https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/resource/semantic_conventions
	//
	// For standalone running Agents (such as OpenTelemetry Collector) the following
	// attributes SHOULD be specified:
	//   - service.name should be set to a reverse FQDN that uniquely identifies the
	//     Agent type, e.g. "io.opentelemetry.collector"
	//   - service.namespace if it is used in the environment where the Agent runs.
	//   - service.version should be set to version number of the Agent build.
	//   - service.instance.id should be set. It may be be set equal to the Agent's
	//     instance uid (equal to ServerToAgent.instance_uid field) or any other value
	//     that uniquely identifies the Agent in combination with other attributes.
	//   - any other attributes that are necessary for uniquely identifying the Agent's
	//     own telemetry.
	//
	// The Agent SHOULD also include these attributes in the Resource of its own
	// telemetry. The combination of identifying attributes SHOULD be sufficient to
	// uniquely identify the Agent's own telemetry in the destination system to which
	// the Agent sends its own telemetry.
	IdentifyingAttributes []*KeyValue `protobuf:"bytes,1,rep,name=identifying_attributes,json=identifyingAttributes,proto3" json:"identifying_attributes,omitempty"`
	// Attributes that do not necessarily identify the Agent but help describe
	// where it runs.
	// The following attributes SHOULD be included:
	//   - os.type, os.version - to describe where the Agent runs.
	//   - host.* to describe the host the Agent runs on.
	//   - cloud.* to describe the cloud where the host is located.
	//   - any other relevant Resource attributes that describe this Agent and the
	//     environment it runs in.
	//   - any user-defined attributes that the end user would like to associate
	//     with this Agent.
	NonIdentifyingAttributes []*KeyValue `` /* 135-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*AgentDescription) Descriptor deprecated

func (*AgentDescription) Descriptor() ([]byte, []int)

Deprecated: Use AgentDescription.ProtoReflect.Descriptor instead.

func (*AgentDescription) GetIdentifyingAttributes

func (x *AgentDescription) GetIdentifyingAttributes() []*KeyValue

func (*AgentDescription) GetNonIdentifyingAttributes

func (x *AgentDescription) GetNonIdentifyingAttributes() []*KeyValue

func (*AgentDescription) ProtoMessage

func (*AgentDescription) ProtoMessage()

func (*AgentDescription) ProtoReflect

func (x *AgentDescription) ProtoReflect() protoreflect.Message

func (*AgentDescription) Reset

func (x *AgentDescription) Reset()

func (*AgentDescription) String

func (x *AgentDescription) String() string

type AgentDisconnect

type AgentDisconnect struct {
	// contains filtered or unexported fields
}

AgentDisconnect is the last message sent from the Agent to the Server. The Server SHOULD forget the association of the Agent instance with the message stream.

If the message stream is closed in the transport layer then the Server SHOULD forget association of all Agent instances that were previously established for this message stream using AgentConnect message, even if the corresponding AgentDisconnect message were not explicitly received from the Agent.

func (*AgentDisconnect) Descriptor deprecated

func (*AgentDisconnect) Descriptor() ([]byte, []int)

Deprecated: Use AgentDisconnect.ProtoReflect.Descriptor instead.

func (*AgentDisconnect) ProtoMessage

func (*AgentDisconnect) ProtoMessage()

func (*AgentDisconnect) ProtoReflect

func (x *AgentDisconnect) ProtoReflect() protoreflect.Message

func (*AgentDisconnect) Reset

func (x *AgentDisconnect) Reset()

func (*AgentDisconnect) String

func (x *AgentDisconnect) String() string

type AgentIdentification

type AgentIdentification struct {

	// When new_instance_uid is set, Agent MUST update instance_uid
	// to the value provided and use it for all further communication.
	NewInstanceUid string `protobuf:"bytes,1,opt,name=new_instance_uid,json=newInstanceUid,proto3" json:"new_instance_uid,omitempty"`
	// contains filtered or unexported fields
}

Properties related to identification of the Agent, which can be overridden by the Server if needed

func (*AgentIdentification) Descriptor deprecated

func (*AgentIdentification) Descriptor() ([]byte, []int)

Deprecated: Use AgentIdentification.ProtoReflect.Descriptor instead.

func (*AgentIdentification) GetNewInstanceUid

func (x *AgentIdentification) GetNewInstanceUid() string

func (*AgentIdentification) ProtoMessage

func (*AgentIdentification) ProtoMessage()

func (*AgentIdentification) ProtoReflect

func (x *AgentIdentification) ProtoReflect() protoreflect.Message

func (*AgentIdentification) Reset

func (x *AgentIdentification) Reset()

func (*AgentIdentification) String

func (x *AgentIdentification) String() string

type AgentRemoteConfig

type AgentRemoteConfig struct {

	// Agent config offered by the management Server to the Agent instance. SHOULD NOT be
	// set if the config for this Agent has not changed since it was last requested (i.e.
	// AgentConfigRequest.last_remote_config_hash field is equal to
	// AgentConfigResponse.config_hash field).
	Config *AgentConfigMap `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	// Hash of "config". The Agent SHOULD include this value in subsequent
	// RemoteConfigStatus messages in the last_remote_config_hash field. This in turn
	// allows the management Server to identify that a new config is available for the Agent.
	//
	// This field MUST be always set if the management Server supports remote configuration
	// of agents.
	//
	// Management Server must choose a hashing function that guarantees lack of hash
	// collisions in practice.
	ConfigHash []byte `protobuf:"bytes,2,opt,name=config_hash,json=configHash,proto3" json:"config_hash,omitempty"`
	// contains filtered or unexported fields
}

func (*AgentRemoteConfig) Descriptor deprecated

func (*AgentRemoteConfig) Descriptor() ([]byte, []int)

Deprecated: Use AgentRemoteConfig.ProtoReflect.Descriptor instead.

func (*AgentRemoteConfig) GetConfig

func (x *AgentRemoteConfig) GetConfig() *AgentConfigMap

func (*AgentRemoteConfig) GetConfigHash

func (x *AgentRemoteConfig) GetConfigHash() []byte

func (*AgentRemoteConfig) ProtoMessage

func (*AgentRemoteConfig) ProtoMessage()

func (*AgentRemoteConfig) ProtoReflect

func (x *AgentRemoteConfig) ProtoReflect() protoreflect.Message

func (*AgentRemoteConfig) Reset

func (x *AgentRemoteConfig) Reset()

func (*AgentRemoteConfig) String

func (x *AgentRemoteConfig) String() string

type AgentToServer

type AgentToServer struct {

	// Globally unique identifier of the running instance of the Agent. SHOULD remain
	// unchanged for the lifetime of the Agent process.
	// Recommended format: https://github.com/ulid/spec
	InstanceUid string `protobuf:"bytes,1,opt,name=instance_uid,json=instanceUid,proto3" json:"instance_uid,omitempty"`
	// The sequence number is incremented by 1 for every AgentToServer sent
	// by the Agent. This allows the Server to detect that it missed a message when
	// it notices that the sequence_num is not exactly by 1 greater than the previously
	// received one.
	SequenceNum uint64 `protobuf:"varint,2,opt,name=sequence_num,json=sequenceNum,proto3" json:"sequence_num,omitempty"`
	// Data that describes the Agent, its type, where it runs, etc.
	// May be omitted if nothing changed since last AgentToServer message.
	AgentDescription *AgentDescription `protobuf:"bytes,3,opt,name=agent_description,json=agentDescription,proto3" json:"agent_description,omitempty"`
	// Bitmask of flags defined by AgentCapabilities enum.
	// All bits that are not defined in AgentCapabilities enum MUST be set to 0 by
	// the Agent. This allows extending the protocol and the AgentCapabilities enum
	// in the future such that old Agents automatically report that they don't
	// support the new capability.
	// This field MUST be always set.
	Capabilities uint64 `protobuf:"varint,4,opt,name=capabilities,proto3" json:"capabilities,omitempty"`
	// The current health of the Agent and sub-components. The top-level ComponentHealth represents
	// the health of the Agent overall. May be omitted if nothing changed since last AgentToServer
	// message.
	// Status: [Beta]
	Health *ComponentHealth `protobuf:"bytes,5,opt,name=health,proto3" json:"health,omitempty"`
	// The current effective configuration of the Agent. The effective configuration is
	// the one that is currently used by the Agent. The effective configuration may be
	// different from the remote configuration received from the Server earlier, e.g.
	// because the Agent uses a local configuration instead (or in addition).
	//
	// This field SHOULD be unset if the effective config is unchanged since the last
	// AgentToServer message.
	EffectiveConfig *EffectiveConfig `protobuf:"bytes,6,opt,name=effective_config,json=effectiveConfig,proto3" json:"effective_config,omitempty"`
	// The status of the remote config that was previously received from the Server.
	// This field SHOULD be unset if the remote config status is unchanged since the
	// last AgentToServer message.
	RemoteConfigStatus *RemoteConfigStatus `protobuf:"bytes,7,opt,name=remote_config_status,json=remoteConfigStatus,proto3" json:"remote_config_status,omitempty"`
	// The list of the Agent packages, including package statuses. This field SHOULD be
	// unset if this information is unchanged since the last AgentToServer message for
	// this Agent was sent in the stream.
	// Status: [Beta]
	PackageStatuses *PackageStatuses `protobuf:"bytes,8,opt,name=package_statuses,json=packageStatuses,proto3" json:"package_statuses,omitempty"`
	// AgentDisconnect MUST be set in the last AgentToServer message sent from the
	// Agent to the Server.
	AgentDisconnect *AgentDisconnect `protobuf:"bytes,9,opt,name=agent_disconnect,json=agentDisconnect,proto3" json:"agent_disconnect,omitempty"`
	// Bit flags as defined by AgentToServerFlags bit masks.
	Flags uint64 `protobuf:"varint,10,opt,name=flags,proto3" json:"flags,omitempty"`
	// A request to create connection settings. This field is set for flows where
	// the Agent initiates the creation of connection settings.
	// Status: [Development]
	ConnectionSettingsRequest *ConnectionSettingsRequest `` /* 139-byte string literal not displayed */
	// A message indicating custom capabilities supported by the Agent.
	// Status: [Development]
	CustomCapabilities *CustomCapabilities `protobuf:"bytes,12,opt,name=custom_capabilities,json=customCapabilities,proto3" json:"custom_capabilities,omitempty"`
	// A custom message sent from an Agent to the Server.
	// Status: [Development]
	CustomMessage *CustomMessage `protobuf:"bytes,13,opt,name=custom_message,json=customMessage,proto3" json:"custom_message,omitempty"`
	// contains filtered or unexported fields
}

func (*AgentToServer) Descriptor deprecated

func (*AgentToServer) Descriptor() ([]byte, []int)

Deprecated: Use AgentToServer.ProtoReflect.Descriptor instead.

func (*AgentToServer) GetAgentDescription

func (x *AgentToServer) GetAgentDescription() *AgentDescription

func (*AgentToServer) GetAgentDisconnect

func (x *AgentToServer) GetAgentDisconnect() *AgentDisconnect

func (*AgentToServer) GetCapabilities

func (x *AgentToServer) GetCapabilities() uint64

func (*AgentToServer) GetConnectionSettingsRequest added in v0.10.0

func (x *AgentToServer) GetConnectionSettingsRequest() *ConnectionSettingsRequest

func (*AgentToServer) GetCustomCapabilities added in v0.13.0

func (x *AgentToServer) GetCustomCapabilities() *CustomCapabilities

func (*AgentToServer) GetCustomMessage added in v0.13.0

func (x *AgentToServer) GetCustomMessage() *CustomMessage

func (*AgentToServer) GetEffectiveConfig

func (x *AgentToServer) GetEffectiveConfig() *EffectiveConfig

func (*AgentToServer) GetFlags

func (x *AgentToServer) GetFlags() uint64

func (*AgentToServer) GetHealth added in v0.3.0

func (x *AgentToServer) GetHealth() *ComponentHealth

func (*AgentToServer) GetInstanceUid

func (x *AgentToServer) GetInstanceUid() string

func (*AgentToServer) GetPackageStatuses

func (x *AgentToServer) GetPackageStatuses() *PackageStatuses

func (*AgentToServer) GetRemoteConfigStatus

func (x *AgentToServer) GetRemoteConfigStatus() *RemoteConfigStatus

func (*AgentToServer) GetSequenceNum added in v0.2.0

func (x *AgentToServer) GetSequenceNum() uint64

func (*AgentToServer) ProtoMessage

func (*AgentToServer) ProtoMessage()

func (*AgentToServer) ProtoReflect

func (x *AgentToServer) ProtoReflect() protoreflect.Message

func (*AgentToServer) Reset

func (x *AgentToServer) Reset()

func (*AgentToServer) String

func (x *AgentToServer) String() string

type AgentToServerFlags added in v0.4.0

type AgentToServerFlags int32
const (
	AgentToServerFlags_AgentToServerFlags_Unspecified AgentToServerFlags = 0
	// The Agent requests Server go generate a new instance_uid, which will
	// be sent back in ServerToAgent message
	AgentToServerFlags_AgentToServerFlags_RequestInstanceUid AgentToServerFlags = 1
)

func (AgentToServerFlags) Descriptor added in v0.4.0

func (AgentToServerFlags) Enum added in v0.4.0

func (AgentToServerFlags) EnumDescriptor deprecated added in v0.4.0

func (AgentToServerFlags) EnumDescriptor() ([]byte, []int)

Deprecated: Use AgentToServerFlags.Descriptor instead.

func (AgentToServerFlags) Number added in v0.4.0

func (AgentToServerFlags) String added in v0.4.0

func (x AgentToServerFlags) String() string

func (AgentToServerFlags) Type added in v0.4.0

type AnyValue

type AnyValue struct {

	// The value is one of the listed fields. It is valid for all values to be unspecified
	// in which case this AnyValue is considered to be "null".
	//
	// Types that are assignable to Value:
	//
	//	*AnyValue_StringValue
	//	*AnyValue_BoolValue
	//	*AnyValue_IntValue
	//	*AnyValue_DoubleValue
	//	*AnyValue_ArrayValue
	//	*AnyValue_KvlistValue
	//	*AnyValue_BytesValue
	Value isAnyValue_Value `protobuf_oneof:"value"`
	// contains filtered or unexported fields
}

AnyValue is used to represent any type of attribute value. AnyValue may contain a primitive value such as a string or integer or it may contain an arbitrary nested object containing arrays, key-value lists and primitives.

func (*AnyValue) Descriptor deprecated

func (*AnyValue) Descriptor() ([]byte, []int)

Deprecated: Use AnyValue.ProtoReflect.Descriptor instead.

func (*AnyValue) GetArrayValue

func (x *AnyValue) GetArrayValue() *ArrayValue

func (*AnyValue) GetBoolValue

func (x *AnyValue) GetBoolValue() bool

func (*AnyValue) GetBytesValue

func (x *AnyValue) GetBytesValue() []byte

func (*AnyValue) GetDoubleValue

func (x *AnyValue) GetDoubleValue() float64

func (*AnyValue) GetIntValue

func (x *AnyValue) GetIntValue() int64

func (*AnyValue) GetKvlistValue

func (x *AnyValue) GetKvlistValue() *KeyValueList

func (*AnyValue) GetStringValue

func (x *AnyValue) GetStringValue() string

func (*AnyValue) GetValue

func (m *AnyValue) GetValue() isAnyValue_Value

func (*AnyValue) ProtoMessage

func (*AnyValue) ProtoMessage()

func (*AnyValue) ProtoReflect

func (x *AnyValue) ProtoReflect() protoreflect.Message

func (*AnyValue) Reset

func (x *AnyValue) Reset()

func (*AnyValue) String

func (x *AnyValue) String() string

type AnyValue_ArrayValue

type AnyValue_ArrayValue struct {
	ArrayValue *ArrayValue `protobuf:"bytes,5,opt,name=array_value,json=arrayValue,proto3,oneof"`
}

type AnyValue_BoolValue

type AnyValue_BoolValue struct {
	BoolValue bool `protobuf:"varint,2,opt,name=bool_value,json=boolValue,proto3,oneof"`
}

type AnyValue_BytesValue

type AnyValue_BytesValue struct {
	BytesValue []byte `protobuf:"bytes,7,opt,name=bytes_value,json=bytesValue,proto3,oneof"`
}

type AnyValue_DoubleValue

type AnyValue_DoubleValue struct {
	DoubleValue float64 `protobuf:"fixed64,4,opt,name=double_value,json=doubleValue,proto3,oneof"`
}

type AnyValue_IntValue

type AnyValue_IntValue struct {
	IntValue int64 `protobuf:"varint,3,opt,name=int_value,json=intValue,proto3,oneof"`
}

type AnyValue_KvlistValue

type AnyValue_KvlistValue struct {
	KvlistValue *KeyValueList `protobuf:"bytes,6,opt,name=kvlist_value,json=kvlistValue,proto3,oneof"`
}

type AnyValue_StringValue

type AnyValue_StringValue struct {
	StringValue string `protobuf:"bytes,1,opt,name=string_value,json=stringValue,proto3,oneof"`
}

type ArrayValue

type ArrayValue struct {

	// Array of values. The array may be empty (contain 0 elements).
	Values []*AnyValue `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

ArrayValue is a list of AnyValue messages. We need ArrayValue as a message since oneof in AnyValue does not allow repeated fields.

func (*ArrayValue) Descriptor deprecated

func (*ArrayValue) Descriptor() ([]byte, []int)

Deprecated: Use ArrayValue.ProtoReflect.Descriptor instead.

func (*ArrayValue) GetValues

func (x *ArrayValue) GetValues() []*AnyValue

func (*ArrayValue) ProtoMessage

func (*ArrayValue) ProtoMessage()

func (*ArrayValue) ProtoReflect

func (x *ArrayValue) ProtoReflect() protoreflect.Message

func (*ArrayValue) Reset

func (x *ArrayValue) Reset()

func (*ArrayValue) String

func (x *ArrayValue) String() string

type CertificateRequest added in v0.10.0

type CertificateRequest struct {

	// PEM-encoded Client Certificate Signing Request (CSR), signed by client's private key.
	// The Server SHOULD validate the request and SHOULD respond with a
	// OpAMPConnectionSettings where the certificate.public_key contains the issued
	// certificate.
	Csr []byte `protobuf:"bytes,1,opt,name=csr,proto3" json:"csr,omitempty"`
	// contains filtered or unexported fields
}

Status: [Development]

func (*CertificateRequest) Descriptor deprecated added in v0.10.0

func (*CertificateRequest) Descriptor() ([]byte, []int)

Deprecated: Use CertificateRequest.ProtoReflect.Descriptor instead.

func (*CertificateRequest) GetCsr added in v0.10.0

func (x *CertificateRequest) GetCsr() []byte

func (*CertificateRequest) ProtoMessage added in v0.10.0

func (*CertificateRequest) ProtoMessage()

func (*CertificateRequest) ProtoReflect added in v0.10.0

func (x *CertificateRequest) ProtoReflect() protoreflect.Message

func (*CertificateRequest) Reset added in v0.10.0

func (x *CertificateRequest) Reset()

func (*CertificateRequest) String added in v0.10.0

func (x *CertificateRequest) String() string

type CommandType added in v0.4.0

type CommandType int32

Status: [Beta]

const (
	// The Agent should restart. This request will be ignored if the Agent does not
	// support restart.
	CommandType_CommandType_Restart CommandType = 0
)

func (CommandType) Descriptor added in v0.4.0

func (CommandType) Enum added in v0.4.0

func (x CommandType) Enum() *CommandType

func (CommandType) EnumDescriptor deprecated added in v0.4.0

func (CommandType) EnumDescriptor() ([]byte, []int)

Deprecated: Use CommandType.Descriptor instead.

func (CommandType) Number added in v0.4.0

func (x CommandType) Number() protoreflect.EnumNumber

func (CommandType) String added in v0.4.0

func (x CommandType) String() string

func (CommandType) Type added in v0.4.0

type ComponentHealth added in v0.10.0

type ComponentHealth struct {

	// Set to true if the component is up and healthy.
	Healthy bool `protobuf:"varint,1,opt,name=healthy,proto3" json:"healthy,omitempty"`
	// Timestamp since the component is up, i.e. when the component was started.
	// Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
	// If the component is not running MUST be set to 0.
	StartTimeUnixNano uint64 `protobuf:"fixed64,2,opt,name=start_time_unix_nano,json=startTimeUnixNano,proto3" json:"start_time_unix_nano,omitempty"`
	// Human-readable error message if the component is in erroneous state. SHOULD be set
	// when healthy==false.
	LastError string `protobuf:"bytes,3,opt,name=last_error,json=lastError,proto3" json:"last_error,omitempty"`
	// Component status represented as a string. The status values are defined by agent-specific
	// semantics and not at the protocol level.
	Status string `protobuf:"bytes,4,opt,name=status,proto3" json:"status,omitempty"`
	// The time when the component status was observed. Value is UNIX Epoch time in
	// nanoseconds since 00:00:00 UTC on 1 January 1970.
	StatusTimeUnixNano uint64 `protobuf:"fixed64,5,opt,name=status_time_unix_nano,json=statusTimeUnixNano,proto3" json:"status_time_unix_nano,omitempty"`
	// A map to store more granular, sub-component health. It can nest as deeply as needed to
	// describe the underlying system.
	ComponentHealthMap map[string]*ComponentHealth `` /* 205-byte string literal not displayed */
	// contains filtered or unexported fields
}

The health of the Agent and sub-components Status: [Beta]

func (*ComponentHealth) Descriptor deprecated added in v0.10.0

func (*ComponentHealth) Descriptor() ([]byte, []int)

Deprecated: Use ComponentHealth.ProtoReflect.Descriptor instead.

func (*ComponentHealth) GetComponentHealthMap added in v0.10.0

func (x *ComponentHealth) GetComponentHealthMap() map[string]*ComponentHealth

func (*ComponentHealth) GetHealthy added in v0.10.0

func (x *ComponentHealth) GetHealthy() bool

func (*ComponentHealth) GetLastError added in v0.10.0

func (x *ComponentHealth) GetLastError() string

func (*ComponentHealth) GetStartTimeUnixNano added in v0.10.0

func (x *ComponentHealth) GetStartTimeUnixNano() uint64

func (*ComponentHealth) GetStatus added in v0.10.0

func (x *ComponentHealth) GetStatus() string

func (*ComponentHealth) GetStatusTimeUnixNano added in v0.10.0

func (x *ComponentHealth) GetStatusTimeUnixNano() uint64

func (*ComponentHealth) ProtoMessage added in v0.10.0

func (*ComponentHealth) ProtoMessage()

func (*ComponentHealth) ProtoReflect added in v0.10.0

func (x *ComponentHealth) ProtoReflect() protoreflect.Message

func (*ComponentHealth) Reset added in v0.10.0

func (x *ComponentHealth) Reset()

func (*ComponentHealth) String added in v0.10.0

func (x *ComponentHealth) String() string

type ConnectionSettingsOffers

type ConnectionSettingsOffers struct {

	// Hash of all settings, including settings that may be omitted from this message
	// because they are unchanged.
	Hash []byte `protobuf:"bytes,1,opt,name=hash,proto3" json:"hash,omitempty"`
	// Settings to connect to the OpAMP Server.
	// If this field is not set then the Agent should assume that the settings are
	// unchanged and should continue using existing settings.
	// The Agent MUST verify the offered connection settings by actually connecting
	// before accepting the setting to ensure it does not loose access to the OpAMP
	// Server due to invalid settings.
	Opamp *OpAMPConnectionSettings `protobuf:"bytes,2,opt,name=opamp,proto3" json:"opamp,omitempty"`
	// Settings to connect to an OTLP metrics backend to send Agent's own metrics to.
	// If this field is not set then the Agent should assume that the settings
	// are unchanged.
	//
	// Once accepted the Agent should periodically send to the specified destination
	// its own metrics, i.e. metrics of the Agent process and any custom metrics that
	// describe the Agent state.
	//
	// All attributes specified in the identifying_attributes field in AgentDescription
	// message SHOULD be also specified in the Resource of the reported OTLP metrics.
	//
	// Attributes specified in the non_identifying_attributes field in
	// AgentDescription message may be also specified in the Resource of the reported
	// OTLP metrics, in which case they SHOULD have exactly the same values.
	//
	// Process metrics MUST follow the conventions for processes:
	// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/semantic_conventions/process-metrics.md
	OwnMetrics *TelemetryConnectionSettings `protobuf:"bytes,3,opt,name=own_metrics,json=ownMetrics,proto3" json:"own_metrics,omitempty"`
	// Similar to own_metrics, but for traces.
	OwnTraces *TelemetryConnectionSettings `protobuf:"bytes,4,opt,name=own_traces,json=ownTraces,proto3" json:"own_traces,omitempty"`
	// Similar to own_metrics, but for logs.
	OwnLogs *TelemetryConnectionSettings `protobuf:"bytes,5,opt,name=own_logs,json=ownLogs,proto3" json:"own_logs,omitempty"`
	// Another set of connection settings, with a string name associated with each.
	// How the Agent uses these is Agent-specific. Typically the name represents
	// the name of the destination to connect to (as it is known to the Agent).
	// If this field is not set then the Agent should assume that the other_connections
	// settings are unchanged.
	OtherConnections map[string]*OtherConnectionSettings `` /* 197-byte string literal not displayed */
	// contains filtered or unexported fields
}

Status: [Beta]

func (*ConnectionSettingsOffers) Descriptor deprecated

func (*ConnectionSettingsOffers) Descriptor() ([]byte, []int)

Deprecated: Use ConnectionSettingsOffers.ProtoReflect.Descriptor instead.

func (*ConnectionSettingsOffers) GetHash

func (x *ConnectionSettingsOffers) GetHash() []byte

func (*ConnectionSettingsOffers) GetOpamp

func (*ConnectionSettingsOffers) GetOtherConnections

func (x *ConnectionSettingsOffers) GetOtherConnections() map[string]*OtherConnectionSettings

func (*ConnectionSettingsOffers) GetOwnLogs

func (*ConnectionSettingsOffers) GetOwnMetrics

func (*ConnectionSettingsOffers) GetOwnTraces

func (*ConnectionSettingsOffers) ProtoMessage

func (*ConnectionSettingsOffers) ProtoMessage()

func (*ConnectionSettingsOffers) ProtoReflect

func (x *ConnectionSettingsOffers) ProtoReflect() protoreflect.Message

func (*ConnectionSettingsOffers) Reset

func (x *ConnectionSettingsOffers) Reset()

func (*ConnectionSettingsOffers) String

func (x *ConnectionSettingsOffers) String() string

type ConnectionSettingsRequest added in v0.10.0

type ConnectionSettingsRequest struct {

	// Request for OpAMP connection settings. If this field is unset
	// then the ConnectionSettingsRequest message is empty and is not actionable
	// for the Server.
	Opamp *OpAMPConnectionSettingsRequest `protobuf:"bytes,1,opt,name=opamp,proto3" json:"opamp,omitempty"`
	// contains filtered or unexported fields
}

ConnectionSettingsRequest is a request from the Agent to the Server to create and respond with an offer of connection settings for the Agent. Status: [Development]

func (*ConnectionSettingsRequest) Descriptor deprecated added in v0.10.0

func (*ConnectionSettingsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ConnectionSettingsRequest.ProtoReflect.Descriptor instead.

func (*ConnectionSettingsRequest) GetOpamp added in v0.10.0

func (*ConnectionSettingsRequest) ProtoMessage added in v0.10.0

func (*ConnectionSettingsRequest) ProtoMessage()

func (*ConnectionSettingsRequest) ProtoReflect added in v0.10.0

func (*ConnectionSettingsRequest) Reset added in v0.10.0

func (x *ConnectionSettingsRequest) Reset()

func (*ConnectionSettingsRequest) String added in v0.10.0

func (x *ConnectionSettingsRequest) String() string

type CustomCapabilities added in v0.13.0

type CustomCapabilities struct {

	// A list of custom capabilities that are supported. Each capability is a reverse FQDN
	// with optional version information that uniquely identifies the custom capability
	// and should match a capability specified in a supported CustomMessage.
	// Status: [Development]
	Capabilities []string `protobuf:"bytes,1,rep,name=capabilities,proto3" json:"capabilities,omitempty"`
	// contains filtered or unexported fields
}

func (*CustomCapabilities) Descriptor deprecated added in v0.13.0

func (*CustomCapabilities) Descriptor() ([]byte, []int)

Deprecated: Use CustomCapabilities.ProtoReflect.Descriptor instead.

func (*CustomCapabilities) GetCapabilities added in v0.13.0

func (x *CustomCapabilities) GetCapabilities() []string

func (*CustomCapabilities) ProtoMessage added in v0.13.0

func (*CustomCapabilities) ProtoMessage()

func (*CustomCapabilities) ProtoReflect added in v0.13.0

func (x *CustomCapabilities) ProtoReflect() protoreflect.Message

func (*CustomCapabilities) Reset added in v0.13.0

func (x *CustomCapabilities) Reset()

func (*CustomCapabilities) String added in v0.13.0

func (x *CustomCapabilities) String() string

type CustomMessage added in v0.13.0

type CustomMessage struct {

	// A reverse FQDN that uniquely identifies the capability and matches one of the
	// capabilities in the CustomCapabilities message.
	// Status: [Development]
	Capability string `protobuf:"bytes,1,opt,name=capability,proto3" json:"capability,omitempty"`
	// Type of message within the capability. The capability defines the types of custom
	// messages that are used to implement the capability. The type must only be unique
	// within the capability.
	// Status: [Development]
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// Binary data of the message. The capability must specify the format of the contents
	// of the data for each custom message type it defines.
	// Status: [Development]
	Data []byte `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*CustomMessage) Descriptor deprecated added in v0.13.0

func (*CustomMessage) Descriptor() ([]byte, []int)

Deprecated: Use CustomMessage.ProtoReflect.Descriptor instead.

func (*CustomMessage) GetCapability added in v0.13.0

func (x *CustomMessage) GetCapability() string

func (*CustomMessage) GetData added in v0.13.0

func (x *CustomMessage) GetData() []byte

func (*CustomMessage) GetType added in v0.13.0

func (x *CustomMessage) GetType() string

func (*CustomMessage) ProtoMessage added in v0.13.0

func (*CustomMessage) ProtoMessage()

func (*CustomMessage) ProtoReflect added in v0.13.0

func (x *CustomMessage) ProtoReflect() protoreflect.Message

func (*CustomMessage) Reset added in v0.13.0

func (x *CustomMessage) Reset()

func (*CustomMessage) String added in v0.13.0

func (x *CustomMessage) String() string

type DownloadableFile

type DownloadableFile struct {

	// The URL from which the file can be downloaded using HTTP GET request.
	// The Server at the specified URL SHOULD support range requests
	// to allow for resuming downloads.
	DownloadUrl string `protobuf:"bytes,1,opt,name=download_url,json=downloadUrl,proto3" json:"download_url,omitempty"`
	// The hash of the file content. Can be used by the Agent to verify that the file
	// was downloaded correctly.
	ContentHash []byte `protobuf:"bytes,2,opt,name=content_hash,json=contentHash,proto3" json:"content_hash,omitempty"`
	// Optional signature of the file content. Can be used by the Agent to verify the
	// authenticity of the downloaded file, for example can be the
	// [detached GPG signature](https://www.gnupg.org/gph/en/manual/x135.html#AEN160).
	// The exact signing and verification method is Agent specific. See
	// https://github.com/open-telemetry/opamp-spec/blob/main/specification.md#code-signing
	// for recommendations.
	Signature []byte `protobuf:"bytes,3,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

Status: [Beta]

func (*DownloadableFile) Descriptor deprecated

func (*DownloadableFile) Descriptor() ([]byte, []int)

Deprecated: Use DownloadableFile.ProtoReflect.Descriptor instead.

func (*DownloadableFile) GetContentHash

func (x *DownloadableFile) GetContentHash() []byte

func (*DownloadableFile) GetDownloadUrl

func (x *DownloadableFile) GetDownloadUrl() string

func (*DownloadableFile) GetSignature

func (x *DownloadableFile) GetSignature() []byte

func (*DownloadableFile) ProtoMessage

func (*DownloadableFile) ProtoMessage()

func (*DownloadableFile) ProtoReflect

func (x *DownloadableFile) ProtoReflect() protoreflect.Message

func (*DownloadableFile) Reset

func (x *DownloadableFile) Reset()

func (*DownloadableFile) String

func (x *DownloadableFile) String() string

type EffectiveConfig

type EffectiveConfig struct {

	// The effective config of the Agent.
	ConfigMap *AgentConfigMap `protobuf:"bytes,1,opt,name=config_map,json=configMap,proto3" json:"config_map,omitempty"`
	// contains filtered or unexported fields
}

func (*EffectiveConfig) Descriptor deprecated

func (*EffectiveConfig) Descriptor() ([]byte, []int)

Deprecated: Use EffectiveConfig.ProtoReflect.Descriptor instead.

func (*EffectiveConfig) GetConfigMap

func (x *EffectiveConfig) GetConfigMap() *AgentConfigMap

func (*EffectiveConfig) ProtoMessage

func (*EffectiveConfig) ProtoMessage()

func (*EffectiveConfig) ProtoReflect

func (x *EffectiveConfig) ProtoReflect() protoreflect.Message

func (*EffectiveConfig) Reset

func (x *EffectiveConfig) Reset()

func (*EffectiveConfig) String

func (x *EffectiveConfig) String() string
type Header struct {
	Key   string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Status: [Beta]

func (*Header) Descriptor deprecated

func (*Header) Descriptor() ([]byte, []int)

Deprecated: Use Header.ProtoReflect.Descriptor instead.

func (*Header) GetKey

func (x *Header) GetKey() string

func (*Header) GetValue

func (x *Header) GetValue() string

func (*Header) ProtoMessage

func (*Header) ProtoMessage()

func (*Header) ProtoReflect

func (x *Header) ProtoReflect() protoreflect.Message

func (*Header) Reset

func (x *Header) Reset()

func (*Header) String

func (x *Header) String() string

type Headers

type Headers struct {
	Headers []*Header `protobuf:"bytes,1,rep,name=headers,proto3" json:"headers,omitempty"`
	// contains filtered or unexported fields
}

Status: [Beta]

func (*Headers) Descriptor deprecated

func (*Headers) Descriptor() ([]byte, []int)

Deprecated: Use Headers.ProtoReflect.Descriptor instead.

func (*Headers) GetHeaders

func (x *Headers) GetHeaders() []*Header

func (*Headers) ProtoMessage

func (*Headers) ProtoMessage()

func (*Headers) ProtoReflect

func (x *Headers) ProtoReflect() protoreflect.Message

func (*Headers) Reset

func (x *Headers) Reset()

func (*Headers) String

func (x *Headers) String() string

type KeyValue

type KeyValue struct {
	Key   string    `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	Value *AnyValue `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

KeyValue is a key-value pair that is used to store Span attributes, Link attributes, etc.

func (*KeyValue) Descriptor deprecated

func (*KeyValue) Descriptor() ([]byte, []int)

Deprecated: Use KeyValue.ProtoReflect.Descriptor instead.

func (*KeyValue) GetKey

func (x *KeyValue) GetKey() string

func (*KeyValue) GetValue

func (x *KeyValue) GetValue() *AnyValue

func (*KeyValue) ProtoMessage

func (*KeyValue) ProtoMessage()

func (*KeyValue) ProtoReflect

func (x *KeyValue) ProtoReflect() protoreflect.Message

func (*KeyValue) Reset

func (x *KeyValue) Reset()

func (*KeyValue) String

func (x *KeyValue) String() string

type KeyValueList

type KeyValueList struct {

	// A collection of key/value pairs of key-value pairs. The list may be empty (may
	// contain 0 elements).
	Values []*KeyValue `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

KeyValueList is a list of KeyValue messages. We need KeyValueList as a message since `oneof` in AnyValue does not allow repeated fields. Everywhere else where we need a list of KeyValue messages (e.g. in Span) we use `repeated KeyValue` directly to avoid unnecessary extra wrapping (which slows down the protocol). The 2 approaches are semantically equivalent.

func (*KeyValueList) Descriptor deprecated

func (*KeyValueList) Descriptor() ([]byte, []int)

Deprecated: Use KeyValueList.ProtoReflect.Descriptor instead.

func (*KeyValueList) GetValues

func (x *KeyValueList) GetValues() []*KeyValue

func (*KeyValueList) ProtoMessage

func (*KeyValueList) ProtoMessage()

func (*KeyValueList) ProtoReflect

func (x *KeyValueList) ProtoReflect() protoreflect.Message

func (*KeyValueList) Reset

func (x *KeyValueList) Reset()

func (*KeyValueList) String

func (x *KeyValueList) String() string

type OpAMPConnectionSettings

type OpAMPConnectionSettings struct {

	// OpAMP Server URL This MUST be a WebSocket or HTTP URL and MUST be non-empty, for
	// example: "wss://example.com:4318/v1/opamp"
	DestinationEndpoint string `protobuf:"bytes,1,opt,name=destination_endpoint,json=destinationEndpoint,proto3" json:"destination_endpoint,omitempty"`
	// Optional headers to use when connecting. Typically used to set access tokens or
	// other authorization headers. For HTTP-based protocols the Agent should
	// set these in the request headers.
	// For example:
	// key="Authorization", Value="Basic YWxhZGRpbjpvcGVuc2VzYW1l".
	Headers *Headers `protobuf:"bytes,2,opt,name=headers,proto3" json:"headers,omitempty"`
	// The Agent should use the offered certificate to connect to the destination
	// from now on. If the Agent is able to validate and connect using the offered
	// certificate the Agent SHOULD forget any previous client certificates
	// for this connection.
	// This field is optional: if omitted the client SHOULD NOT use a client-side certificate.
	// This field can be used to perform a client certificate revocation/rotation.
	Certificate *TLSCertificate `protobuf:"bytes,3,opt,name=certificate,proto3" json:"certificate,omitempty"`
	// contains filtered or unexported fields
}

The OpAMPConnectionSettings message is a collection of fields which comprise an offer from the Server to the Agent to use the specified settings for OpAMP connection. Status: [Beta]

func (*OpAMPConnectionSettings) Descriptor deprecated

func (*OpAMPConnectionSettings) Descriptor() ([]byte, []int)

Deprecated: Use OpAMPConnectionSettings.ProtoReflect.Descriptor instead.

func (*OpAMPConnectionSettings) GetCertificate

func (x *OpAMPConnectionSettings) GetCertificate() *TLSCertificate

func (*OpAMPConnectionSettings) GetDestinationEndpoint

func (x *OpAMPConnectionSettings) GetDestinationEndpoint() string

func (*OpAMPConnectionSettings) GetHeaders

func (x *OpAMPConnectionSettings) GetHeaders() *Headers

func (*OpAMPConnectionSettings) ProtoMessage

func (*OpAMPConnectionSettings) ProtoMessage()

func (*OpAMPConnectionSettings) ProtoReflect

func (x *OpAMPConnectionSettings) ProtoReflect() protoreflect.Message

func (*OpAMPConnectionSettings) Reset

func (x *OpAMPConnectionSettings) Reset()

func (*OpAMPConnectionSettings) String

func (x *OpAMPConnectionSettings) String() string

type OpAMPConnectionSettingsRequest added in v0.10.0

type OpAMPConnectionSettingsRequest struct {

	// A request to create a client certificate. This is used to initiate a
	// Client Signing Request (CSR) flow.
	// Required.
	CertificateRequest *CertificateRequest `protobuf:"bytes,1,opt,name=certificate_request,json=certificateRequest,proto3" json:"certificate_request,omitempty"`
	// contains filtered or unexported fields
}

OpAMPConnectionSettingsRequest is a request for the Server to produce a OpAMPConnectionSettings in its response. Status: [Development]

func (*OpAMPConnectionSettingsRequest) Descriptor deprecated added in v0.10.0

func (*OpAMPConnectionSettingsRequest) Descriptor() ([]byte, []int)

Deprecated: Use OpAMPConnectionSettingsRequest.ProtoReflect.Descriptor instead.

func (*OpAMPConnectionSettingsRequest) GetCertificateRequest added in v0.10.0

func (x *OpAMPConnectionSettingsRequest) GetCertificateRequest() *CertificateRequest

func (*OpAMPConnectionSettingsRequest) ProtoMessage added in v0.10.0

func (*OpAMPConnectionSettingsRequest) ProtoMessage()

func (*OpAMPConnectionSettingsRequest) ProtoReflect added in v0.10.0

func (*OpAMPConnectionSettingsRequest) Reset added in v0.10.0

func (x *OpAMPConnectionSettingsRequest) Reset()

func (*OpAMPConnectionSettingsRequest) String added in v0.10.0

type OtherConnectionSettings

type OtherConnectionSettings struct {

	// A URL, host:port or some other destination specifier.
	DestinationEndpoint string `protobuf:"bytes,1,opt,name=destination_endpoint,json=destinationEndpoint,proto3" json:"destination_endpoint,omitempty"`
	// Optional headers to use when connecting. Typically used to set access tokens or
	// other authorization headers. For HTTP-based protocols the Agent should
	// set these in the request headers.
	// For example:
	// key="Authorization", Value="Basic YWxhZGRpbjpvcGVuc2VzYW1l".
	Headers *Headers `protobuf:"bytes,2,opt,name=headers,proto3" json:"headers,omitempty"`
	// The Agent should use the offered certificate to connect to the destination
	// from now on. If the Agent is able to validate and connect using the offered
	// certificate the Agent SHOULD forget any previous client certificates
	// for this connection.
	// This field is optional: if omitted the client SHOULD NOT use a client-side certificate.
	// This field can be used to perform a client certificate revocation/rotation.
	Certificate *TLSCertificate `protobuf:"bytes,3,opt,name=certificate,proto3" json:"certificate,omitempty"`
	// Other connection settings. These are Agent-specific and are up to the Agent
	// interpret.
	OtherSettings map[string]string `` /* 188-byte string literal not displayed */
	// contains filtered or unexported fields
}

The OtherConnectionSettings message is a collection of fields which comprise an offer from the Server to the Agent to use the specified settings for a network connection. It is not required that all fields in this message are specified. The Server may specify only some of the fields, in which case it means that the Server offers the Agent to change only those fields, while keeping the rest of the fields unchanged.

For example the Server may send a ConnectionSettings message with only the certificate field set, while all other fields are unset. This means that the Server wants the Agent to use a new certificate and continue sending to the destination it is currently sending using the current header and other settings.

For fields which reference other messages the field is considered unset when the reference is unset.

For primitive field (string) we rely on the "flags" to describe that the field is not set (this is done to overcome the limitation of old protoc compilers don't generate methods that allow to check for the presence of the field. Status: [Beta]

func (*OtherConnectionSettings) Descriptor deprecated

func (*OtherConnectionSettings) Descriptor() ([]byte, []int)

Deprecated: Use OtherConnectionSettings.ProtoReflect.Descriptor instead.

func (*OtherConnectionSettings) GetCertificate

func (x *OtherConnectionSettings) GetCertificate() *TLSCertificate

func (*OtherConnectionSettings) GetDestinationEndpoint

func (x *OtherConnectionSettings) GetDestinationEndpoint() string

func (*OtherConnectionSettings) GetHeaders

func (x *OtherConnectionSettings) GetHeaders() *Headers

func (*OtherConnectionSettings) GetOtherSettings

func (x *OtherConnectionSettings) GetOtherSettings() map[string]string

func (*OtherConnectionSettings) ProtoMessage

func (*OtherConnectionSettings) ProtoMessage()

func (*OtherConnectionSettings) ProtoReflect

func (x *OtherConnectionSettings) ProtoReflect() protoreflect.Message

func (*OtherConnectionSettings) Reset

func (x *OtherConnectionSettings) Reset()

func (*OtherConnectionSettings) String

func (x *OtherConnectionSettings) String() string

type PackageAvailable

type PackageAvailable struct {
	Type PackageType `protobuf:"varint,1,opt,name=type,proto3,enum=opamp.proto.PackageType" json:"type,omitempty"`
	// The package version that is available on the Server side. The Agent may for
	// example use this information to avoid downloading a package that was previously
	// already downloaded and failed to install.
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// The downloadable file of the package.
	File *DownloadableFile `protobuf:"bytes,3,opt,name=file,proto3" json:"file,omitempty"`
	// The hash of the package. SHOULD be calculated based on all other fields of the
	// PackageAvailable message and content of the file of the package. The hash is
	// used by the Agent to determine if the package it has is different from the
	// package the Server is offering.
	Hash []byte `protobuf:"bytes,4,opt,name=hash,proto3" json:"hash,omitempty"`
	// contains filtered or unexported fields
}

Each Agent is composed of one or more packages. A package has a name and content stored in a file. The content of the files, functionality provided by the packages, how they are stored and used by the Agent side is Agent type-specific and is outside the concerns of the OpAMP protocol.

If the Agent does not have an installed package with the specified name then it SHOULD download it from the specified URL and install it.

If the Agent already has an installed package with the specified name but with a different hash then the Agent SHOULD download and install the package again, since it is a different version of the same package.

If the Agent has an installed package with the specified name and the same hash then the Agent does not need to do anything, it already has the right version of the package. Status: [Beta]

func (*PackageAvailable) Descriptor deprecated

func (*PackageAvailable) Descriptor() ([]byte, []int)

Deprecated: Use PackageAvailable.ProtoReflect.Descriptor instead.

func (*PackageAvailable) GetFile

func (x *PackageAvailable) GetFile() *DownloadableFile

func (*PackageAvailable) GetHash

func (x *PackageAvailable) GetHash() []byte

func (*PackageAvailable) GetType

func (x *PackageAvailable) GetType() PackageType

func (*PackageAvailable) GetVersion

func (x *PackageAvailable) GetVersion() string

func (*PackageAvailable) ProtoMessage

func (*PackageAvailable) ProtoMessage()

func (*PackageAvailable) ProtoReflect

func (x *PackageAvailable) ProtoReflect() protoreflect.Message

func (*PackageAvailable) Reset

func (x *PackageAvailable) Reset()

func (*PackageAvailable) String

func (x *PackageAvailable) String() string

type PackageStatus

type PackageStatus struct {

	// Package name. MUST be always set and MUST match the key in the packages field
	// of PackageStatuses message.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The version of the package that the Agent has.
	// MUST be set if the Agent has this package.
	// MUST be empty if the Agent does not have this package. This may be the case
	// for example if the package was offered by the Server but failed to install
	// and the Agent did not have this package previously.
	AgentHasVersion string `protobuf:"bytes,2,opt,name=agent_has_version,json=agentHasVersion,proto3" json:"agent_has_version,omitempty"`
	// The hash of the package that the Agent has.
	// MUST be set if the Agent has this package.
	// MUST be empty if the Agent does not have this package. This may be the case for
	// example if the package was offered by the Server but failed to install and the
	// Agent did not have this package previously.
	AgentHasHash []byte `protobuf:"bytes,3,opt,name=agent_has_hash,json=agentHasHash,proto3" json:"agent_has_hash,omitempty"`
	// The version of the package that the Server offered to the Agent.
	// MUST be set if the installation of the package is initiated by an earlier offer
	// from the Server to install this package.
	//
	// MUST be empty if the Agent has this package but it was installed locally and
	// was not offered by the Server.
	//
	// Note that it is possible for both agent_has_version and server_offered_version
	// fields to be set and to have different values. This is for example possible if
	// the Agent already has a version of the package successfully installed, the Server
	// offers a different version, but the Agent fails to install that version.
	ServerOfferedVersion string `protobuf:"bytes,4,opt,name=server_offered_version,json=serverOfferedVersion,proto3" json:"server_offered_version,omitempty"`
	// The hash of the package that the Server offered to the Agent.
	// MUST be set if the installation of the package is initiated by an earlier
	// offer from the Server to install this package.
	//
	// MUST be empty if the Agent has this package but it was installed locally and
	// was not offered by the Server.
	//
	// Note that it is possible for both agent_has_hash and server_offered_hash
	// fields to be set and to have different values. This is for example possible if
	// the Agent already has a version of the package successfully installed, the
	// Server offers a different version, but the Agent fails to install that version.
	ServerOfferedHash []byte            `protobuf:"bytes,5,opt,name=server_offered_hash,json=serverOfferedHash,proto3" json:"server_offered_hash,omitempty"`
	Status            PackageStatusEnum `protobuf:"varint,6,opt,name=status,proto3,enum=opamp.proto.PackageStatusEnum" json:"status,omitempty"`
	// Error message if the status is erroneous.
	ErrorMessage string `protobuf:"bytes,7,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// contains filtered or unexported fields
}

The status of a single package. Status: [Beta]

func (*PackageStatus) Descriptor deprecated

func (*PackageStatus) Descriptor() ([]byte, []int)

Deprecated: Use PackageStatus.ProtoReflect.Descriptor instead.

func (*PackageStatus) GetAgentHasHash

func (x *PackageStatus) GetAgentHasHash() []byte

func (*PackageStatus) GetAgentHasVersion

func (x *PackageStatus) GetAgentHasVersion() string

func (*PackageStatus) GetErrorMessage

func (x *PackageStatus) GetErrorMessage() string

func (*PackageStatus) GetName

func (x *PackageStatus) GetName() string

func (*PackageStatus) GetServerOfferedHash

func (x *PackageStatus) GetServerOfferedHash() []byte

func (*PackageStatus) GetServerOfferedVersion

func (x *PackageStatus) GetServerOfferedVersion() string

func (*PackageStatus) GetStatus

func (x *PackageStatus) GetStatus() PackageStatusEnum

func (*PackageStatus) ProtoMessage

func (*PackageStatus) ProtoMessage()

func (*PackageStatus) ProtoReflect

func (x *PackageStatus) ProtoReflect() protoreflect.Message

func (*PackageStatus) Reset

func (x *PackageStatus) Reset()

func (*PackageStatus) String

func (x *PackageStatus) String() string

type PackageStatusEnum added in v0.4.0

type PackageStatusEnum int32

The status of this package. Status: [Beta]

const (
	// Package is successfully installed by the Agent.
	// The error_message field MUST NOT be set.
	PackageStatusEnum_PackageStatusEnum_Installed PackageStatusEnum = 0
	// Installation of this package has not yet started.
	PackageStatusEnum_PackageStatusEnum_InstallPending PackageStatusEnum = 1
	// Agent is currently downloading and installing the package.
	// server_offered_hash field MUST be set to indicate the version that the
	// Agent is installing. The error_message field MUST NOT be set.
	PackageStatusEnum_PackageStatusEnum_Installing PackageStatusEnum = 2
	// Agent tried to install the package but installation failed.
	// server_offered_hash field MUST be set to indicate the version that the Agent
	// tried to install. The error_message may also contain more details about
	// the failure.
	PackageStatusEnum_PackageStatusEnum_InstallFailed PackageStatusEnum = 3
)

func (PackageStatusEnum) Descriptor added in v0.4.0

func (PackageStatusEnum) Enum added in v0.4.0

func (PackageStatusEnum) EnumDescriptor deprecated added in v0.4.0

func (PackageStatusEnum) EnumDescriptor() ([]byte, []int)

Deprecated: Use PackageStatusEnum.Descriptor instead.

func (PackageStatusEnum) Number added in v0.4.0

func (PackageStatusEnum) String added in v0.4.0

func (x PackageStatusEnum) String() string

func (PackageStatusEnum) Type added in v0.4.0

type PackageStatuses

type PackageStatuses struct {

	// A map of PackageStatus messages, where the keys are package names.
	// The key MUST match the name field of PackageStatus message.
	Packages map[string]*PackageStatus `` /* 157-byte string literal not displayed */
	// The aggregate hash of all packages that this Agent previously received from the
	// Server via PackagesAvailable message.
	//
	// The Server SHOULD compare this hash to the aggregate hash of all packages that
	// it has for this Agent and if the hashes are different the Server SHOULD send
	// an PackagesAvailable message to the Agent.
	ServerProvidedAllPackagesHash []byte `` /* 154-byte string literal not displayed */
	// This field is set if the Agent encountered an error when processing the
	// PackagesAvailable message and that error is not related to any particular single
	// package.
	// The field must be unset is there were no processing errors.
	ErrorMessage string `protobuf:"bytes,3,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// contains filtered or unexported fields
}

The PackageStatuses message describes the status of all packages that the Agent has or was offered. Status: [Beta]

func (*PackageStatuses) Descriptor deprecated

func (*PackageStatuses) Descriptor() ([]byte, []int)

Deprecated: Use PackageStatuses.ProtoReflect.Descriptor instead.

func (*PackageStatuses) GetErrorMessage

func (x *PackageStatuses) GetErrorMessage() string

func (*PackageStatuses) GetPackages

func (x *PackageStatuses) GetPackages() map[string]*PackageStatus

func (*PackageStatuses) GetServerProvidedAllPackagesHash

func (x *PackageStatuses) GetServerProvidedAllPackagesHash() []byte

func (*PackageStatuses) ProtoMessage

func (*PackageStatuses) ProtoMessage()

func (*PackageStatuses) ProtoReflect

func (x *PackageStatuses) ProtoReflect() protoreflect.Message

func (*PackageStatuses) Reset

func (x *PackageStatuses) Reset()

func (*PackageStatuses) String

func (x *PackageStatuses) String() string

type PackageType added in v0.4.0

type PackageType int32

The type of the package, either an addon or a top-level package. Status: [Beta]

const (
	PackageType_PackageType_TopLevel PackageType = 0
	PackageType_PackageType_Addon    PackageType = 1
)

func (PackageType) Descriptor added in v0.4.0

func (PackageType) Enum added in v0.4.0

func (x PackageType) Enum() *PackageType

func (PackageType) EnumDescriptor deprecated added in v0.4.0

func (PackageType) EnumDescriptor() ([]byte, []int)

Deprecated: Use PackageType.Descriptor instead.

func (PackageType) Number added in v0.4.0

func (x PackageType) Number() protoreflect.EnumNumber

func (PackageType) String added in v0.4.0

func (x PackageType) String() string

func (PackageType) Type added in v0.4.0

type PackagesAvailable

type PackagesAvailable struct {

	// Map of packages. Keys are package names, values are the packages available for download.
	Packages map[string]*PackageAvailable `` /* 157-byte string literal not displayed */
	// Aggregate hash of all remotely installed packages. The Agent SHOULD include this
	// value in subsequent PackageStatuses messages. This in turn allows the management
	// Server to identify that a different set of packages is available for the Agent
	// and specify the available packages in the next ServerToAgent message.
	//
	// This field MUST be always set if the management Server supports packages
	// of agents.
	//
	// The hash is calculated as an aggregate of all packages names and content.
	AllPackagesHash []byte `protobuf:"bytes,2,opt,name=all_packages_hash,json=allPackagesHash,proto3" json:"all_packages_hash,omitempty"`
	// contains filtered or unexported fields
}

List of packages that the Server offers to the Agent. Status: [Beta]

func (*PackagesAvailable) Descriptor deprecated

func (*PackagesAvailable) Descriptor() ([]byte, []int)

Deprecated: Use PackagesAvailable.ProtoReflect.Descriptor instead.

func (*PackagesAvailable) GetAllPackagesHash

func (x *PackagesAvailable) GetAllPackagesHash() []byte

func (*PackagesAvailable) GetPackages

func (x *PackagesAvailable) GetPackages() map[string]*PackageAvailable

func (*PackagesAvailable) ProtoMessage

func (*PackagesAvailable) ProtoMessage()

func (*PackagesAvailable) ProtoReflect

func (x *PackagesAvailable) ProtoReflect() protoreflect.Message

func (*PackagesAvailable) Reset

func (x *PackagesAvailable) Reset()

func (*PackagesAvailable) String

func (x *PackagesAvailable) String() string

type RemoteConfigStatus

type RemoteConfigStatus struct {

	// The hash of the remote config that was last received by this Agent in the
	// AgentRemoteConfig.config_hash field.
	// The Server SHOULD compare this hash with the config hash
	// it has for the Agent and if the hashes are different the Server MUST include
	// the remote_config field in the response in the ServerToAgent message.
	LastRemoteConfigHash []byte               `protobuf:"bytes,1,opt,name=last_remote_config_hash,json=lastRemoteConfigHash,proto3" json:"last_remote_config_hash,omitempty"`
	Status               RemoteConfigStatuses `protobuf:"varint,2,opt,name=status,proto3,enum=opamp.proto.RemoteConfigStatuses" json:"status,omitempty"`
	// Optional error message if status==FAILED.
	ErrorMessage string `protobuf:"bytes,3,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// contains filtered or unexported fields
}

func (*RemoteConfigStatus) Descriptor deprecated

func (*RemoteConfigStatus) Descriptor() ([]byte, []int)

Deprecated: Use RemoteConfigStatus.ProtoReflect.Descriptor instead.

func (*RemoteConfigStatus) GetErrorMessage

func (x *RemoteConfigStatus) GetErrorMessage() string

func (*RemoteConfigStatus) GetLastRemoteConfigHash

func (x *RemoteConfigStatus) GetLastRemoteConfigHash() []byte

func (*RemoteConfigStatus) GetStatus

func (*RemoteConfigStatus) ProtoMessage

func (*RemoteConfigStatus) ProtoMessage()

func (*RemoteConfigStatus) ProtoReflect

func (x *RemoteConfigStatus) ProtoReflect() protoreflect.Message

func (*RemoteConfigStatus) Reset

func (x *RemoteConfigStatus) Reset()

func (*RemoteConfigStatus) String

func (x *RemoteConfigStatus) String() string

type RemoteConfigStatuses added in v0.4.0

type RemoteConfigStatuses int32
const (
	// The value of status field is not set.
	RemoteConfigStatuses_RemoteConfigStatuses_UNSET RemoteConfigStatuses = 0
	// Remote config was successfully applied by the Agent.
	RemoteConfigStatuses_RemoteConfigStatuses_APPLIED RemoteConfigStatuses = 1
	// Agent is currently applying the remote config that it received earlier.
	RemoteConfigStatuses_RemoteConfigStatuses_APPLYING RemoteConfigStatuses = 2
	// Agent tried to apply the config received earlier, but it failed.
	// See error_message for more details.
	RemoteConfigStatuses_RemoteConfigStatuses_FAILED RemoteConfigStatuses = 3
)

func (RemoteConfigStatuses) Descriptor added in v0.4.0

func (RemoteConfigStatuses) Enum added in v0.4.0

func (RemoteConfigStatuses) EnumDescriptor deprecated added in v0.4.0

func (RemoteConfigStatuses) EnumDescriptor() ([]byte, []int)

Deprecated: Use RemoteConfigStatuses.Descriptor instead.

func (RemoteConfigStatuses) Number added in v0.4.0

func (RemoteConfigStatuses) String added in v0.4.0

func (x RemoteConfigStatuses) String() string

func (RemoteConfigStatuses) Type added in v0.4.0

type RetryInfo

type RetryInfo struct {
	RetryAfterNanoseconds uint64 `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*RetryInfo) Descriptor deprecated

func (*RetryInfo) Descriptor() ([]byte, []int)

Deprecated: Use RetryInfo.ProtoReflect.Descriptor instead.

func (*RetryInfo) GetRetryAfterNanoseconds

func (x *RetryInfo) GetRetryAfterNanoseconds() uint64

func (*RetryInfo) ProtoMessage

func (*RetryInfo) ProtoMessage()

func (*RetryInfo) ProtoReflect

func (x *RetryInfo) ProtoReflect() protoreflect.Message

func (*RetryInfo) Reset

func (x *RetryInfo) Reset()

func (*RetryInfo) String

func (x *RetryInfo) String() string

type ServerCapabilities

type ServerCapabilities int32
const (
	// The capabilities field is unspecified.
	ServerCapabilities_ServerCapabilities_Unspecified ServerCapabilities = 0
	// The Server can accept status reports. This bit MUST be set, since all Server
	// MUST be able to accept status reports.
	ServerCapabilities_ServerCapabilities_AcceptsStatus ServerCapabilities = 1
	// The Server can offer remote configuration to the Agent.
	ServerCapabilities_ServerCapabilities_OffersRemoteConfig ServerCapabilities = 2
	// The Server can accept EffectiveConfig in AgentToServer.
	ServerCapabilities_ServerCapabilities_AcceptsEffectiveConfig ServerCapabilities = 4
	// The Server can offer Packages.
	// Status: [Beta]
	ServerCapabilities_ServerCapabilities_OffersPackages ServerCapabilities = 8
	// The Server can accept Packages status.
	// Status: [Beta]
	ServerCapabilities_ServerCapabilities_AcceptsPackagesStatus ServerCapabilities = 16
	// The Server can offer connection settings.
	// Status: [Beta]
	ServerCapabilities_ServerCapabilities_OffersConnectionSettings ServerCapabilities = 32
	// The Server can accept ConnectionSettingsRequest and respond with an offer.
	// Status: [Development]
	ServerCapabilities_ServerCapabilities_AcceptsConnectionSettingsRequest ServerCapabilities = 64
)

func (ServerCapabilities) Descriptor

func (ServerCapabilities) Enum

func (ServerCapabilities) EnumDescriptor deprecated

func (ServerCapabilities) EnumDescriptor() ([]byte, []int)

Deprecated: Use ServerCapabilities.Descriptor instead.

func (ServerCapabilities) Number

func (ServerCapabilities) String

func (x ServerCapabilities) String() string

func (ServerCapabilities) Type

type ServerErrorResponse

type ServerErrorResponse struct {
	Type ServerErrorResponseType `protobuf:"varint,1,opt,name=type,proto3,enum=opamp.proto.ServerErrorResponseType" json:"type,omitempty"`
	// Error message in the string form, typically human readable.
	ErrorMessage string `protobuf:"bytes,2,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// Types that are assignable to Details:
	//
	//	*ServerErrorResponse_RetryInfo
	Details isServerErrorResponse_Details `protobuf_oneof:"Details"`
	// contains filtered or unexported fields
}

func (*ServerErrorResponse) Descriptor deprecated

func (*ServerErrorResponse) Descriptor() ([]byte, []int)

Deprecated: Use ServerErrorResponse.ProtoReflect.Descriptor instead.

func (*ServerErrorResponse) GetDetails

func (m *ServerErrorResponse) GetDetails() isServerErrorResponse_Details

func (*ServerErrorResponse) GetErrorMessage

func (x *ServerErrorResponse) GetErrorMessage() string

func (*ServerErrorResponse) GetRetryInfo

func (x *ServerErrorResponse) GetRetryInfo() *RetryInfo

func (*ServerErrorResponse) GetType

func (*ServerErrorResponse) ProtoMessage

func (*ServerErrorResponse) ProtoMessage()

func (*ServerErrorResponse) ProtoReflect

func (x *ServerErrorResponse) ProtoReflect() protoreflect.Message

func (*ServerErrorResponse) Reset

func (x *ServerErrorResponse) Reset()

func (*ServerErrorResponse) String

func (x *ServerErrorResponse) String() string

type ServerErrorResponseType added in v0.4.0

type ServerErrorResponseType int32
const (
	// Unknown error. Something went wrong, but it is not known what exactly.
	// The Agent SHOULD NOT retry the message.
	// The error_message field may contain a description of the problem.
	ServerErrorResponseType_ServerErrorResponseType_Unknown ServerErrorResponseType = 0
	// The AgentToServer message was malformed. The Agent SHOULD NOT retry
	// the message.
	ServerErrorResponseType_ServerErrorResponseType_BadRequest ServerErrorResponseType = 1
	// The Server is overloaded and unable to process the request. The Agent
	// should retry the message later. retry_info field may be optionally
	// set with additional information about retrying.
	ServerErrorResponseType_ServerErrorResponseType_Unavailable ServerErrorResponseType = 2
)

func (ServerErrorResponseType) Descriptor added in v0.4.0

func (ServerErrorResponseType) Enum added in v0.4.0

func (ServerErrorResponseType) EnumDescriptor deprecated added in v0.4.0

func (ServerErrorResponseType) EnumDescriptor() ([]byte, []int)

Deprecated: Use ServerErrorResponseType.Descriptor instead.

func (ServerErrorResponseType) Number added in v0.4.0

func (ServerErrorResponseType) String added in v0.4.0

func (x ServerErrorResponseType) String() string

func (ServerErrorResponseType) Type added in v0.4.0

type ServerErrorResponse_RetryInfo

type ServerErrorResponse_RetryInfo struct {
	// Additional information about retrying if type==UNAVAILABLE.
	RetryInfo *RetryInfo `protobuf:"bytes,3,opt,name=retry_info,json=retryInfo,proto3,oneof"`
}

type ServerToAgent

type ServerToAgent struct {

	// Agent instance uid. MUST match the instance_uid field in AgentToServer message.
	// Used for multiplexing messages from/to multiple agents using one message stream.
	InstanceUid string `protobuf:"bytes,1,opt,name=instance_uid,json=instanceUid,proto3" json:"instance_uid,omitempty"`
	// error_response is set if the Server wants to indicate that something went wrong
	// during processing of an AgentToServer message. If error_response is set then
	// all other fields below must be unset and vice versa, if any of the fields below is
	// set then error_response must be unset.
	ErrorResponse *ServerErrorResponse `protobuf:"bytes,2,opt,name=error_response,json=errorResponse,proto3" json:"error_response,omitempty"`
	// remote_config field is set when the Server has a remote config offer for the Agent.
	RemoteConfig *AgentRemoteConfig `protobuf:"bytes,3,opt,name=remote_config,json=remoteConfig,proto3" json:"remote_config,omitempty"`
	// This field is set when the Server wants the Agent to change one or more
	// of its client connection settings (destination, headers, certificate, etc).
	// Status: [Beta]
	ConnectionSettings *ConnectionSettingsOffers `protobuf:"bytes,4,opt,name=connection_settings,json=connectionSettings,proto3" json:"connection_settings,omitempty"`
	// This field is set when the Server has packages to offer to the Agent.
	// Status: [Beta]
	PackagesAvailable *PackagesAvailable `protobuf:"bytes,5,opt,name=packages_available,json=packagesAvailable,proto3" json:"packages_available,omitempty"`
	// Bit flags as defined by ServerToAgentFlags bit masks.
	Flags uint64 `protobuf:"varint,6,opt,name=flags,proto3" json:"flags,omitempty"`
	// Bitmask of flags defined by ServerCapabilities enum.
	// All bits that are not defined in ServerCapabilities enum MUST be set to 0
	// by the Server. This allows extending the protocol and the ServerCapabilities
	// enum in the future such that old Servers automatically report that they
	// don't support the new capability.
	// This field MUST be set in the first ServerToAgent sent by the Server and MAY
	// be omitted in subsequent ServerToAgent messages by setting it to
	// UnspecifiedServerCapability value.
	Capabilities uint64 `protobuf:"varint,7,opt,name=capabilities,proto3" json:"capabilities,omitempty"`
	// Properties related to identification of the Agent, which can be overridden
	// by the Server if needed.
	AgentIdentification *AgentIdentification `protobuf:"bytes,8,opt,name=agent_identification,json=agentIdentification,proto3" json:"agent_identification,omitempty"`
	// Allows the Server to instruct the Agent to perform a command, e.g. RESTART. This field should not be specified
	// with fields other than instance_uid and capabilities. If specified, other fields will be ignored and the command
	// will be performed.
	// Status: [Beta]
	Command *ServerToAgentCommand `protobuf:"bytes,9,opt,name=command,proto3" json:"command,omitempty"`
	// A message indicating custom capabilities supported by the Server.
	// Status: [Development]
	CustomCapabilities *CustomCapabilities `protobuf:"bytes,10,opt,name=custom_capabilities,json=customCapabilities,proto3" json:"custom_capabilities,omitempty"`
	// A custom message sent from the Server to an Agent.
	// Status: [Development]
	CustomMessage *CustomMessage `protobuf:"bytes,11,opt,name=custom_message,json=customMessage,proto3" json:"custom_message,omitempty"`
	// contains filtered or unexported fields
}

func (*ServerToAgent) Descriptor deprecated

func (*ServerToAgent) Descriptor() ([]byte, []int)

Deprecated: Use ServerToAgent.ProtoReflect.Descriptor instead.

func (*ServerToAgent) GetAgentIdentification

func (x *ServerToAgent) GetAgentIdentification() *AgentIdentification

func (*ServerToAgent) GetCapabilities

func (x *ServerToAgent) GetCapabilities() uint64

func (*ServerToAgent) GetCommand

func (x *ServerToAgent) GetCommand() *ServerToAgentCommand

func (*ServerToAgent) GetConnectionSettings

func (x *ServerToAgent) GetConnectionSettings() *ConnectionSettingsOffers

func (*ServerToAgent) GetCustomCapabilities added in v0.13.0

func (x *ServerToAgent) GetCustomCapabilities() *CustomCapabilities

func (*ServerToAgent) GetCustomMessage added in v0.13.0

func (x *ServerToAgent) GetCustomMessage() *CustomMessage

func (*ServerToAgent) GetErrorResponse

func (x *ServerToAgent) GetErrorResponse() *ServerErrorResponse

func (*ServerToAgent) GetFlags

func (x *ServerToAgent) GetFlags() uint64

func (*ServerToAgent) GetInstanceUid

func (x *ServerToAgent) GetInstanceUid() string

func (*ServerToAgent) GetPackagesAvailable

func (x *ServerToAgent) GetPackagesAvailable() *PackagesAvailable

func (*ServerToAgent) GetRemoteConfig

func (x *ServerToAgent) GetRemoteConfig() *AgentRemoteConfig

func (*ServerToAgent) ProtoMessage

func (*ServerToAgent) ProtoMessage()

func (*ServerToAgent) ProtoReflect

func (x *ServerToAgent) ProtoReflect() protoreflect.Message

func (*ServerToAgent) Reset

func (x *ServerToAgent) Reset()

func (*ServerToAgent) String

func (x *ServerToAgent) String() string

type ServerToAgentCommand

type ServerToAgentCommand struct {
	Type CommandType `protobuf:"varint,1,opt,name=type,proto3,enum=opamp.proto.CommandType" json:"type,omitempty"`
	// contains filtered or unexported fields
}

ServerToAgentCommand is sent from the Server to the Agent to request that the Agent perform a command. Status: [Beta]

func (*ServerToAgentCommand) Descriptor deprecated

func (*ServerToAgentCommand) Descriptor() ([]byte, []int)

Deprecated: Use ServerToAgentCommand.ProtoReflect.Descriptor instead.

func (*ServerToAgentCommand) GetType

func (x *ServerToAgentCommand) GetType() CommandType

func (*ServerToAgentCommand) ProtoMessage

func (*ServerToAgentCommand) ProtoMessage()

func (*ServerToAgentCommand) ProtoReflect

func (x *ServerToAgentCommand) ProtoReflect() protoreflect.Message

func (*ServerToAgentCommand) Reset

func (x *ServerToAgentCommand) Reset()

func (*ServerToAgentCommand) String

func (x *ServerToAgentCommand) String() string

type ServerToAgentFlags added in v0.4.0

type ServerToAgentFlags int32
const (
	ServerToAgentFlags_ServerToAgentFlags_Unspecified ServerToAgentFlags = 0
	// ReportFullState flag can be used by the Server if the Agent did not include the
	// particular bit of information in the last status report (which is an allowed
	// optimization) but the Server detects that it does not have it (e.g. was
	// restarted and lost state). The detection happens using
	// AgentToServer.sequence_num values.
	// The Server asks the Agent to report full status.
	ServerToAgentFlags_ServerToAgentFlags_ReportFullState ServerToAgentFlags = 1
)

func (ServerToAgentFlags) Descriptor added in v0.4.0

func (ServerToAgentFlags) Enum added in v0.4.0

func (ServerToAgentFlags) EnumDescriptor deprecated added in v0.4.0

func (ServerToAgentFlags) EnumDescriptor() ([]byte, []int)

Deprecated: Use ServerToAgentFlags.Descriptor instead.

func (ServerToAgentFlags) Number added in v0.4.0

func (ServerToAgentFlags) String added in v0.4.0

func (x ServerToAgentFlags) String() string

func (ServerToAgentFlags) Type added in v0.4.0

type TLSCertificate

type TLSCertificate struct {

	// PEM-encoded public key of the certificate. Required.
	PublicKey []byte `protobuf:"bytes,1,opt,name=public_key,json=publicKey,proto3" json:"public_key,omitempty"`
	// PEM-encoded private key of the certificate. Required.
	PrivateKey []byte `protobuf:"bytes,2,opt,name=private_key,json=privateKey,proto3" json:"private_key,omitempty"`
	// PEM-encoded public key of the CA that signed this certificate.
	// Optional. MUST be specified if the certificate is CA-signed.
	// Can be stored by TLS-terminating intermediary proxies in order to verify
	// the connecting client's certificate in the future.
	// It is not recommended that the Agent accepts this CA as an authority for
	// any purposes.
	CaPublicKey []byte `protobuf:"bytes,3,opt,name=ca_public_key,json=caPublicKey,proto3" json:"ca_public_key,omitempty"`
	// contains filtered or unexported fields
}

Status: [Beta]

func (*TLSCertificate) Descriptor deprecated

func (*TLSCertificate) Descriptor() ([]byte, []int)

Deprecated: Use TLSCertificate.ProtoReflect.Descriptor instead.

func (*TLSCertificate) GetCaPublicKey

func (x *TLSCertificate) GetCaPublicKey() []byte

func (*TLSCertificate) GetPrivateKey

func (x *TLSCertificate) GetPrivateKey() []byte

func (*TLSCertificate) GetPublicKey

func (x *TLSCertificate) GetPublicKey() []byte

func (*TLSCertificate) ProtoMessage

func (*TLSCertificate) ProtoMessage()

func (*TLSCertificate) ProtoReflect

func (x *TLSCertificate) ProtoReflect() protoreflect.Message

func (*TLSCertificate) Reset

func (x *TLSCertificate) Reset()

func (*TLSCertificate) String

func (x *TLSCertificate) String() string

type TelemetryConnectionSettings

type TelemetryConnectionSettings struct {

	// The value MUST be a full URL an OTLP/HTTP/Protobuf receiver with path. Schema
	// SHOULD begin with "https://", for example "https://example.com:4318/v1/metrics"
	// The Agent MAY refuse to send the telemetry if the URL begins with "http://".
	DestinationEndpoint string `protobuf:"bytes,1,opt,name=destination_endpoint,json=destinationEndpoint,proto3" json:"destination_endpoint,omitempty"`
	// Optional headers to use when connecting. Typically used to set access tokens or
	// other authorization headers. For HTTP-based protocols the Agent should
	// set these in the request headers.
	// For example:
	// key="Authorization", Value="Basic YWxhZGRpbjpvcGVuc2VzYW1l".
	Headers *Headers `protobuf:"bytes,2,opt,name=headers,proto3" json:"headers,omitempty"`
	// The Agent should use the offered certificate to connect to the destination
	// from now on. If the Agent is able to validate and connect using the offered
	// certificate the Agent SHOULD forget any previous client certificates
	// for this connection.
	// This field is optional: if omitted the client SHOULD NOT use a client-side certificate.
	// This field can be used to perform a client certificate revocation/rotation.
	Certificate *TLSCertificate `protobuf:"bytes,3,opt,name=certificate,proto3" json:"certificate,omitempty"`
	// contains filtered or unexported fields
}

The TelemetryConnectionSettings message is a collection of fields which comprise an offer from the Server to the Agent to use the specified settings for a network connection to report own telemetry. Status: [Beta]

func (*TelemetryConnectionSettings) Descriptor deprecated

func (*TelemetryConnectionSettings) Descriptor() ([]byte, []int)

Deprecated: Use TelemetryConnectionSettings.ProtoReflect.Descriptor instead.

func (*TelemetryConnectionSettings) GetCertificate

func (x *TelemetryConnectionSettings) GetCertificate() *TLSCertificate

func (*TelemetryConnectionSettings) GetDestinationEndpoint

func (x *TelemetryConnectionSettings) GetDestinationEndpoint() string

func (*TelemetryConnectionSettings) GetHeaders

func (x *TelemetryConnectionSettings) GetHeaders() *Headers

func (*TelemetryConnectionSettings) ProtoMessage

func (*TelemetryConnectionSettings) ProtoMessage()

func (*TelemetryConnectionSettings) ProtoReflect

func (*TelemetryConnectionSettings) Reset

func (x *TelemetryConnectionSettings) Reset()

func (*TelemetryConnectionSettings) String

func (x *TelemetryConnectionSettings) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL