Documentation
¶
Index ¶
- Variables
- type HealthReport
- func (*HealthReport) Descriptor() ([]byte, []int)deprecated
- func (x *HealthReport) GetEmittedAt() string
- func (x *HealthReport) GetEventType() string
- func (x *HealthReport) GetHost() *HostInfo
- func (x *HealthReport) GetIssues() map[string]*Issue
- func (x *HealthReport) GetSchemaVersion() string
- func (x *HealthReport) GetService() string
- func (*HealthReport) ProtoMessage()
- func (x *HealthReport) ProtoReflect() protoreflect.Message
- func (x *HealthReport) Reset()
- func (x *HealthReport) String() string
- type HostInfo
- func (*HostInfo) Descriptor() ([]byte, []int)deprecated
- func (x *HostInfo) GetAgentVersion() string
- func (x *HostInfo) GetHostname() string
- func (x *HostInfo) GetParIds() []string
- func (*HostInfo) ProtoMessage()
- func (x *HostInfo) ProtoReflect() protoreflect.Message
- func (x *HostInfo) Reset()
- func (x *HostInfo) String() string
- type Issue
- func (*Issue) Descriptor() ([]byte, []int)deprecated
- func (x *Issue) GetCategory() string
- func (x *Issue) GetDescription() string
- func (x *Issue) GetDetectedAt() string
- func (x *Issue) GetExtra() *structpb.Struct
- func (x *Issue) GetId() string
- func (x *Issue) GetIssueName() string
- func (x *Issue) GetLocation() string
- func (x *Issue) GetPersistedIssue() *PersistedIssue
- func (x *Issue) GetRemediation() *Remediation
- func (x *Issue) GetSeverity() string
- func (x *Issue) GetSource() string
- func (x *Issue) GetTags() []string
- func (x *Issue) GetTitle() string
- func (*Issue) ProtoMessage()
- func (x *Issue) ProtoReflect() protoreflect.Message
- func (x *Issue) Reset()
- func (x *Issue) String() string
- type IssueReport
- func (*IssueReport) Descriptor() ([]byte, []int)deprecated
- func (x *IssueReport) GetContext() map[string]string
- func (x *IssueReport) GetIssueId() string
- func (x *IssueReport) GetTags() []string
- func (*IssueReport) ProtoMessage()
- func (x *IssueReport) ProtoReflect() protoreflect.Message
- func (x *IssueReport) Reset()
- func (x *IssueReport) String() string
- type IssueState
- type JSONAPIMeta
- func (*JSONAPIMeta) Descriptor() ([]byte, []int)deprecated
- func (x *JSONAPIMeta) GetEmittedAt() string
- func (x *JSONAPIMeta) GetEventType() string
- func (x *JSONAPIMeta) GetSchemaVersion() string
- func (*JSONAPIMeta) ProtoMessage()
- func (x *JSONAPIMeta) ProtoReflect() protoreflect.Message
- func (x *JSONAPIMeta) Reset()
- func (x *JSONAPIMeta) String() string
- type JSONAPIResponse
- func (*JSONAPIResponse) Descriptor() ([]byte, []int)deprecated
- func (x *JSONAPIResponse) GetData() *HealthReport
- func (x *JSONAPIResponse) GetMeta() *JSONAPIMeta
- func (*JSONAPIResponse) ProtoMessage()
- func (x *JSONAPIResponse) ProtoReflect() protoreflect.Message
- func (x *JSONAPIResponse) Reset()
- func (x *JSONAPIResponse) String() string
- type PersistedIssue
- func (*PersistedIssue) Descriptor() ([]byte, []int)deprecated
- func (x *PersistedIssue) GetFirstSeen() string
- func (x *PersistedIssue) GetLastSeen() string
- func (x *PersistedIssue) GetResolvedAt() string
- func (x *PersistedIssue) GetState() IssueState
- func (*PersistedIssue) ProtoMessage()
- func (x *PersistedIssue) ProtoReflect() protoreflect.Message
- func (x *PersistedIssue) Reset()
- func (x *PersistedIssue) String() string
- type Remediation
- func (*Remediation) Descriptor() ([]byte, []int)deprecated
- func (x *Remediation) GetScript() *Script
- func (x *Remediation) GetSteps() []*RemediationStep
- func (x *Remediation) GetSummary() string
- func (*Remediation) ProtoMessage()
- func (x *Remediation) ProtoReflect() protoreflect.Message
- func (x *Remediation) Reset()
- func (x *Remediation) String() string
- type RemediationStep
- func (*RemediationStep) Descriptor() ([]byte, []int)deprecated
- func (x *RemediationStep) GetOrder() int32
- func (x *RemediationStep) GetText() string
- func (*RemediationStep) ProtoMessage()
- func (x *RemediationStep) ProtoReflect() protoreflect.Message
- func (x *RemediationStep) Reset()
- func (x *RemediationStep) String() string
- type Script
- func (*Script) Descriptor() ([]byte, []int)deprecated
- func (x *Script) GetContent() string
- func (x *Script) GetFilename() string
- func (x *Script) GetLanguage() string
- func (x *Script) GetLanguageVersion() string
- func (x *Script) GetRequiresRoot() bool
- func (*Script) ProtoMessage()
- func (x *Script) ProtoReflect() protoreflect.Message
- func (x *Script) Reset()
- func (x *Script) String() string
Constants ¶
This section is empty.
Variables ¶
var ( IssueState_name = map[int32]string{ 0: "ISSUE_STATE_UNSPECIFIED", 1: "ISSUE_STATE_NEW", 2: "ISSUE_STATE_ONGOING", 3: "ISSUE_STATE_RESOLVED", } IssueState_value = map[string]int32{ "ISSUE_STATE_UNSPECIFIED": 0, "ISSUE_STATE_NEW": 1, "ISSUE_STATE_ONGOING": 2, "ISSUE_STATE_RESOLVED": 3, } )
Enum value maps for IssueState.
var File_proto_healthplatform_healthplatform_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type HealthReport ¶
type HealthReport struct {
// SchemaVersion is the version of the schema
SchemaVersion string `protobuf:"bytes,1,opt,name=schema_version,json=schemaVersion,proto3" json:"schema_version,omitempty"`
// EventType is the type of event
EventType string `protobuf:"bytes,2,opt,name=event_type,json=eventType,proto3" json:"event_type,omitempty"`
// EmittedAt is the timestamp when the report was emitted
EmittedAt string `protobuf:"bytes,3,opt,name=emitted_at,json=emittedAt,proto3" json:"emitted_at,omitempty"`
// Host contains host information
Host *HostInfo `protobuf:"bytes,4,opt,name=host,proto3" json:"host,omitempty"`
// Issues is a map of check IDs to their issues
Issues map[string]*Issue `` /* 153-byte string literal not displayed */
// Service is the service that detected the issue (datadog-agent, cluster-agent, backend service)
Service string `protobuf:"bytes,6,opt,name=service,proto3" json:"service,omitempty"`
// contains filtered or unexported fields
}
HealthReport represents the formatted health report structure sent to Datadog intake
func (*HealthReport) Descriptor
deprecated
func (*HealthReport) Descriptor() ([]byte, []int)
Deprecated: Use HealthReport.ProtoReflect.Descriptor instead.
func (*HealthReport) GetEmittedAt ¶
func (x *HealthReport) GetEmittedAt() string
func (*HealthReport) GetEventType ¶
func (x *HealthReport) GetEventType() string
func (*HealthReport) GetHost ¶
func (x *HealthReport) GetHost() *HostInfo
func (*HealthReport) GetIssues ¶
func (x *HealthReport) GetIssues() map[string]*Issue
func (*HealthReport) GetSchemaVersion ¶
func (x *HealthReport) GetSchemaVersion() string
func (*HealthReport) GetService ¶ added in v5.0.182
func (x *HealthReport) GetService() string
func (*HealthReport) ProtoMessage ¶
func (*HealthReport) ProtoMessage()
func (*HealthReport) ProtoReflect ¶
func (x *HealthReport) ProtoReflect() protoreflect.Message
func (*HealthReport) Reset ¶
func (x *HealthReport) Reset()
func (*HealthReport) String ¶
func (x *HealthReport) String() string
type HostInfo ¶
type HostInfo struct {
// Hostname is the hostname of the reporting host
Hostname string `protobuf:"bytes,1,opt,name=hostname,proto3" json:"hostname,omitempty"`
// AgentVersion is the version of the agent
AgentVersion *string `protobuf:"bytes,2,opt,name=agent_version,json=agentVersion,proto3,oneof" json:"agent_version,omitempty"`
// ParIDs are the partition/organization IDs
ParIds []string `protobuf:"bytes,3,rep,name=par_ids,json=parIds,proto3" json:"par_ids,omitempty"`
// contains filtered or unexported fields
}
HostInfo represents the host information in the health report
func (*HostInfo) Descriptor
deprecated
func (*HostInfo) GetAgentVersion ¶
func (*HostInfo) GetHostname ¶
func (*HostInfo) ProtoMessage ¶
func (*HostInfo) ProtoMessage()
func (*HostInfo) ProtoReflect ¶
func (x *HostInfo) ProtoReflect() protoreflect.Message
type Issue ¶
type Issue struct {
// ID is the unique identifier for the issue
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// IssueName is the human-readable name for the issue
IssueName string `protobuf:"bytes,2,opt,name=issue_name,json=issueName,proto3" json:"issue_name,omitempty"`
// Title is the short title/headline of the issue
Title string `protobuf:"bytes,3,opt,name=title,proto3" json:"title,omitempty"`
// Description is the detailed description of the issue
Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
// Category indicates the type/category of the issue (e.g., permissions, connectivity, etc.)
Category string `protobuf:"bytes,5,opt,name=category,proto3" json:"category,omitempty"`
// Location indicates where the issue occurred (e.g., core agent, log agent, etc.)
Location string `protobuf:"bytes,6,opt,name=location,proto3" json:"location,omitempty"`
// Severity indicates the impact level of the issue
Severity string `protobuf:"bytes,7,opt,name=severity,proto3" json:"severity,omitempty"`
// DetectedAt is the timestamp when the issue was detected
DetectedAt string `protobuf:"bytes,8,opt,name=detected_at,json=detectedAt,proto3" json:"detected_at,omitempty"`
// Source is the sub-agent or product that reported the issue
// (e.g., "logs", "apm", "error-tracking", "network-monitoring")
Source string `protobuf:"bytes,9,opt,name=source,proto3" json:"source,omitempty"`
// Extra is optional complementary structured information
Extra *structpb.Struct `protobuf:"bytes,10,opt,name=extra,proto3" json:"extra,omitempty"`
// Remediation provides steps to fix the issue
Remediation *Remediation `protobuf:"bytes,11,opt,name=remediation,proto3" json:"remediation,omitempty"`
// Tags are additional labels for the issue
Tags []string `protobuf:"bytes,12,rep,name=tags,proto3" json:"tags,omitempty"`
// PersistedIssue tracks the lifecycle state of the issue
PersistedIssue *PersistedIssue `protobuf:"bytes,13,opt,name=persisted_issue,json=persistedIssue,proto3" json:"persisted_issue,omitempty"`
// contains filtered or unexported fields
}
Issue represents an individual issue to be reported
func (*Issue) Descriptor
deprecated
func (*Issue) GetCategory ¶
func (*Issue) GetDescription ¶
func (*Issue) GetDetectedAt ¶
func (*Issue) GetIssueName ¶
func (*Issue) GetLocation ¶
func (*Issue) GetPersistedIssue ¶ added in v5.0.182
func (x *Issue) GetPersistedIssue() *PersistedIssue
func (*Issue) GetRemediation ¶
func (x *Issue) GetRemediation() *Remediation
func (*Issue) GetSeverity ¶
func (*Issue) ProtoMessage ¶
func (*Issue) ProtoMessage()
func (*Issue) ProtoReflect ¶
func (x *Issue) ProtoReflect() protoreflect.Message
type IssueReport ¶
type IssueReport struct {
// IssueID is the unique identifier for the type of issue
// The health platform registry uses this to look up all issue details
IssueId string `protobuf:"bytes,1,opt,name=issue_id,json=issueId,proto3" json:"issue_id,omitempty"`
// Context provides variables for filling in templates
// (e.g., {"dockerDir": "/var/lib/docker", "os": "linux"})
Context map[string]string `` /* 155-byte string literal not displayed */
// Tags are optional additional labels for filtering and categorization
// These are appended to the default tags from the registry
Tags []string `protobuf:"bytes,3,rep,name=tags,proto3" json:"tags,omitempty"`
// contains filtered or unexported fields
}
IssueReport represents a lightweight issue report from an integration The health platform fills in all metadata and remediation based on the issue ID
func (*IssueReport) Descriptor
deprecated
func (*IssueReport) Descriptor() ([]byte, []int)
Deprecated: Use IssueReport.ProtoReflect.Descriptor instead.
func (*IssueReport) GetContext ¶
func (x *IssueReport) GetContext() map[string]string
func (*IssueReport) GetIssueId ¶
func (x *IssueReport) GetIssueId() string
func (*IssueReport) GetTags ¶
func (x *IssueReport) GetTags() []string
func (*IssueReport) ProtoMessage ¶
func (*IssueReport) ProtoMessage()
func (*IssueReport) ProtoReflect ¶
func (x *IssueReport) ProtoReflect() protoreflect.Message
func (*IssueReport) Reset ¶
func (x *IssueReport) Reset()
func (*IssueReport) String ¶
func (x *IssueReport) String() string
type IssueState ¶ added in v5.0.182
type IssueState int32
IssueState represents the lifecycle state of an issue
const ( IssueState_ISSUE_STATE_UNSPECIFIED IssueState = 0 IssueState_ISSUE_STATE_NEW IssueState = 1 IssueState_ISSUE_STATE_ONGOING IssueState = 2 IssueState_ISSUE_STATE_RESOLVED IssueState = 3 )
func (IssueState) Descriptor ¶ added in v5.0.182
func (IssueState) Descriptor() protoreflect.EnumDescriptor
func (IssueState) Enum ¶ added in v5.0.182
func (x IssueState) Enum() *IssueState
func (IssueState) EnumDescriptor
deprecated
added in
v5.0.182
func (IssueState) EnumDescriptor() ([]byte, []int)
Deprecated: Use IssueState.Descriptor instead.
func (IssueState) Number ¶ added in v5.0.182
func (x IssueState) Number() protoreflect.EnumNumber
func (IssueState) String ¶ added in v5.0.182
func (x IssueState) String() string
func (IssueState) Type ¶ added in v5.0.182
func (IssueState) Type() protoreflect.EnumType
type JSONAPIMeta ¶
type JSONAPIMeta struct {
// SchemaVersion is the version of the schema
SchemaVersion string `protobuf:"bytes,1,opt,name=schema_version,json=schemaVersion,proto3" json:"schema_version,omitempty"`
// EventType is the type of event
EventType string `protobuf:"bytes,2,opt,name=event_type,json=eventType,proto3" json:"event_type,omitempty"`
// EmittedAt is the timestamp when the report was emitted
EmittedAt string `protobuf:"bytes,3,opt,name=emitted_at,json=emittedAt,proto3" json:"emitted_at,omitempty"`
// contains filtered or unexported fields
}
JSONAPIMeta represents metadata in JSON:API format
func (*JSONAPIMeta) Descriptor
deprecated
func (*JSONAPIMeta) Descriptor() ([]byte, []int)
Deprecated: Use JSONAPIMeta.ProtoReflect.Descriptor instead.
func (*JSONAPIMeta) GetEmittedAt ¶
func (x *JSONAPIMeta) GetEmittedAt() string
func (*JSONAPIMeta) GetEventType ¶
func (x *JSONAPIMeta) GetEventType() string
func (*JSONAPIMeta) GetSchemaVersion ¶
func (x *JSONAPIMeta) GetSchemaVersion() string
func (*JSONAPIMeta) ProtoMessage ¶
func (*JSONAPIMeta) ProtoMessage()
func (*JSONAPIMeta) ProtoReflect ¶
func (x *JSONAPIMeta) ProtoReflect() protoreflect.Message
func (*JSONAPIMeta) Reset ¶
func (x *JSONAPIMeta) Reset()
func (*JSONAPIMeta) String ¶
func (x *JSONAPIMeta) String() string
type JSONAPIResponse ¶
type JSONAPIResponse struct {
// Data contains the health report
Data *HealthReport `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
// Meta contains optional metadata
Meta *JSONAPIMeta `protobuf:"bytes,2,opt,name=meta,proto3" json:"meta,omitempty"`
// contains filtered or unexported fields
}
JSONAPIResponse represents the JSON:API wrapper for health reports
func (*JSONAPIResponse) Descriptor
deprecated
func (*JSONAPIResponse) Descriptor() ([]byte, []int)
Deprecated: Use JSONAPIResponse.ProtoReflect.Descriptor instead.
func (*JSONAPIResponse) GetData ¶
func (x *JSONAPIResponse) GetData() *HealthReport
func (*JSONAPIResponse) GetMeta ¶
func (x *JSONAPIResponse) GetMeta() *JSONAPIMeta
func (*JSONAPIResponse) ProtoMessage ¶
func (*JSONAPIResponse) ProtoMessage()
func (*JSONAPIResponse) ProtoReflect ¶
func (x *JSONAPIResponse) ProtoReflect() protoreflect.Message
func (*JSONAPIResponse) Reset ¶
func (x *JSONAPIResponse) Reset()
func (*JSONAPIResponse) String ¶
func (x *JSONAPIResponse) String() string
type PersistedIssue ¶ added in v5.0.182
type PersistedIssue struct {
// State is the current lifecycle state
State IssueState `protobuf:"varint,1,opt,name=state,proto3,enum=datadog.healthplatform.IssueState" json:"state,omitempty"`
// FirstSeen is the timestamp when the issue was first detected
FirstSeen string `protobuf:"bytes,2,opt,name=first_seen,json=firstSeen,proto3" json:"first_seen,omitempty"`
// LastSeen is the timestamp when the issue was last observed
LastSeen string `protobuf:"bytes,3,opt,name=last_seen,json=lastSeen,proto3" json:"last_seen,omitempty"`
// ResolvedAt is the timestamp when the issue was resolved
ResolvedAt *string `protobuf:"bytes,4,opt,name=resolved_at,json=resolvedAt,proto3,oneof" json:"resolved_at,omitempty"`
// contains filtered or unexported fields
}
PersistedIssue tracks the lifecycle state of a single issue
func (*PersistedIssue) Descriptor
deprecated
added in
v5.0.182
func (*PersistedIssue) Descriptor() ([]byte, []int)
Deprecated: Use PersistedIssue.ProtoReflect.Descriptor instead.
func (*PersistedIssue) GetFirstSeen ¶ added in v5.0.182
func (x *PersistedIssue) GetFirstSeen() string
func (*PersistedIssue) GetLastSeen ¶ added in v5.0.182
func (x *PersistedIssue) GetLastSeen() string
func (*PersistedIssue) GetResolvedAt ¶ added in v5.0.182
func (x *PersistedIssue) GetResolvedAt() string
func (*PersistedIssue) GetState ¶ added in v5.0.182
func (x *PersistedIssue) GetState() IssueState
func (*PersistedIssue) ProtoMessage ¶ added in v5.0.182
func (*PersistedIssue) ProtoMessage()
func (*PersistedIssue) ProtoReflect ¶ added in v5.0.182
func (x *PersistedIssue) ProtoReflect() protoreflect.Message
func (*PersistedIssue) Reset ¶ added in v5.0.182
func (x *PersistedIssue) Reset()
func (*PersistedIssue) String ¶ added in v5.0.182
func (x *PersistedIssue) String() string
type Remediation ¶
type Remediation struct {
// Summary is a brief description of the remediation
Summary string `protobuf:"bytes,1,opt,name=summary,proto3" json:"summary,omitempty"`
// Steps are the ordered steps to fix the issue
Steps []*RemediationStep `protobuf:"bytes,2,rep,name=steps,proto3" json:"steps,omitempty"`
// Script is an automated script to fix the issue
Script *Script `protobuf:"bytes,3,opt,name=script,proto3" json:"script,omitempty"`
// contains filtered or unexported fields
}
Remediation represents remediation steps for an issue
func (*Remediation) Descriptor
deprecated
func (*Remediation) Descriptor() ([]byte, []int)
Deprecated: Use Remediation.ProtoReflect.Descriptor instead.
func (*Remediation) GetScript ¶
func (x *Remediation) GetScript() *Script
func (*Remediation) GetSteps ¶
func (x *Remediation) GetSteps() []*RemediationStep
func (*Remediation) GetSummary ¶
func (x *Remediation) GetSummary() string
func (*Remediation) ProtoMessage ¶
func (*Remediation) ProtoMessage()
func (*Remediation) ProtoReflect ¶
func (x *Remediation) ProtoReflect() protoreflect.Message
func (*Remediation) Reset ¶
func (x *Remediation) Reset()
func (*Remediation) String ¶
func (x *Remediation) String() string
type RemediationStep ¶
type RemediationStep struct {
// Order is the sequence number of the step
Order int32 `protobuf:"varint,1,opt,name=order,proto3" json:"order,omitempty"`
// Text is the description of what to do
Text string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
// contains filtered or unexported fields
}
RemediationStep represents a single remediation step
func (*RemediationStep) Descriptor
deprecated
func (*RemediationStep) Descriptor() ([]byte, []int)
Deprecated: Use RemediationStep.ProtoReflect.Descriptor instead.
func (*RemediationStep) GetOrder ¶
func (x *RemediationStep) GetOrder() int32
func (*RemediationStep) GetText ¶
func (x *RemediationStep) GetText() string
func (*RemediationStep) ProtoMessage ¶
func (*RemediationStep) ProtoMessage()
func (*RemediationStep) ProtoReflect ¶
func (x *RemediationStep) ProtoReflect() protoreflect.Message
func (*RemediationStep) Reset ¶
func (x *RemediationStep) Reset()
func (*RemediationStep) String ¶
func (x *RemediationStep) String() string
type Script ¶
type Script struct {
// Language is the scripting language (e.g., bash, powershell, python, javascript)
Language string `protobuf:"bytes,1,opt,name=language,proto3" json:"language,omitempty"`
// LanguageVersion is the required interpreter version (e.g., "3.8+" for Python, ">=14" for Node.js)
LanguageVersion string `protobuf:"bytes,2,opt,name=language_version,json=languageVersion,proto3" json:"language_version,omitempty"`
// Filename is the suggested filename for the script
Filename string `protobuf:"bytes,3,opt,name=filename,proto3" json:"filename,omitempty"`
// RequiresRoot indicates if the script needs root privileges
RequiresRoot bool `protobuf:"varint,4,opt,name=requires_root,json=requiresRoot,proto3" json:"requires_root,omitempty"`
// Content is the actual script content
Content string `protobuf:"bytes,5,opt,name=content,proto3" json:"content,omitempty"`
// contains filtered or unexported fields
}
Script represents a remediation script
func (*Script) Descriptor
deprecated
func (*Script) GetContent ¶
func (*Script) GetFilename ¶
func (*Script) GetLanguage ¶
func (*Script) GetLanguageVersion ¶
func (*Script) GetRequiresRoot ¶
func (*Script) ProtoMessage ¶
func (*Script) ProtoMessage()
func (*Script) ProtoReflect ¶
func (x *Script) ProtoReflect() protoreflect.Message