Documentation ¶
Overview ¶
Package stats is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterStatsServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterStatsServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client StatsServiceClient) error
- func RegisterStatsServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterStatsServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server StatsServiceServer) error
- func RegisterStatsServiceServer(s *grpc.Server, srv StatsServiceServer)
- type ControlStats
- func (*ControlStats) Descriptor() ([]byte, []int)deprecated
- func (x *ControlStats) GetControl() string
- func (x *ControlStats) GetFailed() int32
- func (x *ControlStats) GetImpact() float32
- func (x *ControlStats) GetPassed() int32
- func (x *ControlStats) GetSkipped() int32
- func (x *ControlStats) GetTitle() string
- func (x *ControlStats) GetWaived() int32
- func (*ControlStats) ProtoMessage()
- func (x *ControlStats) ProtoReflect() protoreflect.Message
- func (x *ControlStats) Reset()
- func (x *ControlStats) String() string
- type ControlsSummary
- func (*ControlsSummary) Descriptor() ([]byte, []int)deprecated
- func (x *ControlsSummary) GetCriticals() int32
- func (x *ControlsSummary) GetFailures() int32
- func (x *ControlsSummary) GetMajors() int32
- func (x *ControlsSummary) GetMinors() int32
- func (x *ControlsSummary) GetPassed() int32
- func (x *ControlsSummary) GetSkipped() int32
- func (x *ControlsSummary) GetWaived() int32
- func (*ControlsSummary) ProtoMessage()
- func (x *ControlsSummary) ProtoReflect() protoreflect.Message
- func (x *ControlsSummary) Reset()
- func (x *ControlsSummary) String() string
- type Empty
- type FailureSummary
- func (*FailureSummary) Descriptor() ([]byte, []int)deprecated
- func (x *FailureSummary) GetFailures() int32
- func (x *FailureSummary) GetId() string
- func (x *FailureSummary) GetName() string
- func (x *FailureSummary) GetProfile() string
- func (*FailureSummary) ProtoMessage()
- func (x *FailureSummary) ProtoReflect() protoreflect.Message
- func (x *FailureSummary) Reset()
- func (x *FailureSummary) String() string
- type Failures
- func (*Failures) Descriptor() ([]byte, []int)deprecated
- func (x *Failures) GetControls() []*FailureSummary
- func (x *Failures) GetEnvironments() []*FailureSummary
- func (x *Failures) GetPlatforms() []*FailureSummary
- func (x *Failures) GetProfiles() []*FailureSummary
- func (*Failures) ProtoMessage()
- func (x *Failures) ProtoReflect() protoreflect.Message
- func (x *Failures) Reset()
- func (x *Failures) String() string
- type GetNodesUsageCountRequest
- type GetNodesUsageCountResponse
- func (*GetNodesUsageCountResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetNodesUsageCountResponse) GetDaysSinceLastPost() int64
- func (x *GetNodesUsageCountResponse) GetNodeCnt() int64
- func (*GetNodesUsageCountResponse) ProtoMessage()
- func (x *GetNodesUsageCountResponse) ProtoReflect() protoreflect.Message
- func (x *GetNodesUsageCountResponse) Reset()
- func (x *GetNodesUsageCountResponse) String() string
- type ListFilter
- type NodeSummary
- func (*NodeSummary) Descriptor() ([]byte, []int)deprecated
- func (x *NodeSummary) GetCompliant() int32
- func (x *NodeSummary) GetHighRisk() int32
- func (x *NodeSummary) GetLowRisk() int32
- func (x *NodeSummary) GetMediumRisk() int32
- func (x *NodeSummary) GetNoncompliant() int32
- func (x *NodeSummary) GetSkipped() int32
- func (x *NodeSummary) GetWaived() int32
- func (*NodeSummary) ProtoMessage()
- func (x *NodeSummary) ProtoReflect() protoreflect.Message
- func (x *NodeSummary) Reset()
- func (x *NodeSummary) String() string
- type Profile
- func (*Profile) Descriptor() ([]byte, []int)deprecated
- func (x *Profile) GetControlStats() []*ControlStats
- func (x *Profile) GetProfileList() []*ProfileList
- func (x *Profile) GetProfileSummary() *ProfileSummary
- func (*Profile) ProtoMessage()
- func (x *Profile) ProtoReflect() protoreflect.Message
- func (x *Profile) Reset()
- func (x *Profile) String() string
- type ProfileList
- func (*ProfileList) Descriptor() ([]byte, []int)deprecated
- func (x *ProfileList) GetCriticals() int32
- func (x *ProfileList) GetFailures() int32
- func (x *ProfileList) GetId() string
- func (x *ProfileList) GetMajors() int32
- func (x *ProfileList) GetMinors() int32
- func (x *ProfileList) GetName() string
- func (x *ProfileList) GetPassed() int32
- func (x *ProfileList) GetSkipped() int32
- func (x *ProfileList) GetWaived() int32
- func (*ProfileList) ProtoMessage()
- func (x *ProfileList) ProtoReflect() protoreflect.Message
- func (x *ProfileList) Reset()
- func (x *ProfileList) String() string
- type ProfileSummary
- func (*ProfileSummary) Descriptor() ([]byte, []int)deprecated
- func (x *ProfileSummary) GetCopyright() string
- func (x *ProfileSummary) GetCopyrightEmail() string
- func (x *ProfileSummary) GetDepends() []*reporting.Dependency
- func (x *ProfileSummary) GetLicense() string
- func (x *ProfileSummary) GetMaintainer() string
- func (x *ProfileSummary) GetName() string
- func (x *ProfileSummary) GetStats() *ProfileSummaryStats
- func (x *ProfileSummary) GetSummary() string
- func (x *ProfileSummary) GetSupports() []*Support
- func (x *ProfileSummary) GetTitle() string
- func (x *ProfileSummary) GetVersion() string
- func (*ProfileSummary) ProtoMessage()
- func (x *ProfileSummary) ProtoReflect() protoreflect.Message
- func (x *ProfileSummary) Reset()
- func (x *ProfileSummary) String() string
- type ProfileSummaryStats
- func (*ProfileSummaryStats) Descriptor() ([]byte, []int)deprecated
- func (x *ProfileSummaryStats) GetFailed() int32
- func (x *ProfileSummaryStats) GetFailedNodes() int32
- func (x *ProfileSummaryStats) GetPassed() int32
- func (x *ProfileSummaryStats) GetSkipped() int32
- func (x *ProfileSummaryStats) GetTotalNodes() int32
- func (x *ProfileSummaryStats) GetWaived() int32
- func (*ProfileSummaryStats) ProtoMessage()
- func (x *ProfileSummaryStats) ProtoReflect() protoreflect.Message
- func (x *ProfileSummaryStats) Reset()
- func (x *ProfileSummaryStats) String() string
- type Query
- func (*Query) Descriptor() ([]byte, []int)deprecated
- func (x *Query) GetFilters() []*ListFilter
- func (x *Query) GetId() string
- func (x *Query) GetInterval() int32
- func (x *Query) GetOrder() Query_OrderType
- func (x *Query) GetPage() int32
- func (x *Query) GetPerPage() int32
- func (x *Query) GetSize() int32
- func (x *Query) GetSort() string
- func (x *Query) GetType() string
- func (*Query) ProtoMessage()
- func (x *Query) ProtoReflect() protoreflect.Message
- func (x *Query) Reset()
- func (x *Query) String() string
- type Query_OrderType
- func (Query_OrderType) Descriptor() protoreflect.EnumDescriptor
- func (x Query_OrderType) Enum() *Query_OrderType
- func (Query_OrderType) EnumDescriptor() ([]byte, []int)deprecated
- func (x Query_OrderType) Number() protoreflect.EnumNumber
- func (x Query_OrderType) String() string
- func (Query_OrderType) Type() protoreflect.EnumType
- type ReportSummary
- func (*ReportSummary) Descriptor() ([]byte, []int)deprecated
- func (x *ReportSummary) GetDuration() float64
- func (x *ReportSummary) GetStartDate() string
- func (x *ReportSummary) GetStats() *Stats
- func (x *ReportSummary) GetStatus() string
- func (*ReportSummary) ProtoMessage()
- func (x *ReportSummary) ProtoReflect() protoreflect.Message
- func (x *ReportSummary) Reset()
- func (x *ReportSummary) String() string
- type Stats
- func (*Stats) Descriptor() ([]byte, []int)deprecated
- func (x *Stats) GetControls() int32
- func (x *Stats) GetEnvironments() int32
- func (x *Stats) GetNodes() int64deprecated
- func (x *Stats) GetNodesCnt() int32
- func (x *Stats) GetPlatforms() int32
- func (x *Stats) GetProfiles() int32
- func (*Stats) ProtoMessage()
- func (x *Stats) ProtoReflect() protoreflect.Message
- func (x *Stats) Reset()
- func (x *Stats) String() string
- type StatsServiceClient
- type StatsServiceServer
- type Summary
- func (*Summary) Descriptor() ([]byte, []int)deprecated
- func (x *Summary) GetControlsSummary() *ControlsSummary
- func (x *Summary) GetNodeSummary() *NodeSummary
- func (x *Summary) GetReportSummary() *ReportSummary
- func (*Summary) ProtoMessage()
- func (x *Summary) ProtoReflect() protoreflect.Message
- func (x *Summary) Reset()
- func (x *Summary) String() string
- type Support
- func (*Support) Descriptor() ([]byte, []int)deprecated
- func (x *Support) GetInspecVersion() string
- func (x *Support) GetOsFamily() string
- func (x *Support) GetOsName() string
- func (x *Support) GetPlatform() string
- func (x *Support) GetPlatformFamily() string
- func (x *Support) GetPlatformName() string
- func (x *Support) GetRelease() string
- func (*Support) ProtoMessage()
- func (x *Support) ProtoReflect() protoreflect.Message
- func (x *Support) Reset()
- func (x *Support) String() string
- type Trend
- func (*Trend) Descriptor() ([]byte, []int)deprecated
- func (x *Trend) GetFailed() int32
- func (x *Trend) GetPassed() int32
- func (x *Trend) GetReportTime() string
- func (x *Trend) GetSkipped() int32
- func (x *Trend) GetWaived() int32
- func (*Trend) ProtoMessage()
- func (x *Trend) ProtoReflect() protoreflect.Message
- func (x *Trend) Reset()
- func (x *Trend) String() string
- type Trends
- type UnimplementedStatsServiceServer
- func (*UnimplementedStatsServiceServer) GetNodesUsageCount(context.Context, *GetNodesUsageCountRequest) (*GetNodesUsageCountResponse, error)
- func (*UnimplementedStatsServiceServer) ReadFailures(context.Context, *Query) (*Failures, error)
- func (*UnimplementedStatsServiceServer) ReadProfiles(context.Context, *Query) (*Profile, error)
- func (*UnimplementedStatsServiceServer) ReadSummary(context.Context, *Query) (*Summary, error)
- func (*UnimplementedStatsServiceServer) ReadTrend(context.Context, *Query) (*Trends, error)
- func (*UnimplementedStatsServiceServer) UpdateTelemetryReported(context.Context, *UpdateTelemetryReportedRequest) (*UpdateTelemetryReportedResponse, error)
- type UpdateTelemetryReportedRequest
- func (*UpdateTelemetryReportedRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateTelemetryReportedRequest) GetLastTelemetryReportedAt() string
- func (*UpdateTelemetryReportedRequest) ProtoMessage()
- func (x *UpdateTelemetryReportedRequest) ProtoReflect() protoreflect.Message
- func (x *UpdateTelemetryReportedRequest) Reset()
- func (x *UpdateTelemetryReportedRequest) String() string
- type UpdateTelemetryReportedResponse
- func (*UpdateTelemetryReportedResponse) Descriptor() ([]byte, []int)deprecated
- func (*UpdateTelemetryReportedResponse) ProtoMessage()
- func (x *UpdateTelemetryReportedResponse) ProtoReflect() protoreflect.Message
- func (x *UpdateTelemetryReportedResponse) Reset()
- func (x *UpdateTelemetryReportedResponse) String() string
Constants ¶
This section is empty.
Variables ¶
var ( Query_OrderType_name = map[int32]string{ 0: "ASC", 1: "DESC", } Query_OrderType_value = map[string]int32{ "ASC": 0, "DESC": 1, } )
Enum value maps for Query_OrderType.
var File_external_compliance_reporting_stats_stats_proto protoreflect.FileDescriptor
Functions ¶
func RegisterStatsServiceHandler ¶
func RegisterStatsServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterStatsServiceHandler registers the http handlers for service StatsService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterStatsServiceHandlerClient ¶
func RegisterStatsServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client StatsServiceClient) error
RegisterStatsServiceHandlerClient registers the http handlers for service StatsService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "StatsServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "StatsServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "StatsServiceClient" to call the correct interceptors.
func RegisterStatsServiceHandlerFromEndpoint ¶
func RegisterStatsServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterStatsServiceHandlerFromEndpoint is same as RegisterStatsServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterStatsServiceHandlerServer ¶
func RegisterStatsServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server StatsServiceServer) error
RegisterStatsServiceHandlerServer registers the http handlers for service StatsService to "mux". UnaryRPC :call StatsServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906.
func RegisterStatsServiceServer ¶
func RegisterStatsServiceServer(s *grpc.Server, srv StatsServiceServer)
Types ¶
type ControlStats ¶
type ControlStats struct { // Control ID. Control string `protobuf:"bytes,1,opt,name=control,proto3" json:"control,omitempty"` // Control title. Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"` // Count of passed nodes that executed the control. Passed int32 `protobuf:"varint,3,opt,name=passed,proto3" json:"passed,omitempty"` // Count of failed nodes that executed the control. Failed int32 `protobuf:"varint,4,opt,name=failed,proto3" json:"failed,omitempty"` // Count of skipped nodes that executed the control. Skipped int32 `protobuf:"varint,5,opt,name=skipped,proto3" json:"skipped,omitempty"` // Impact of the control. Impact float32 `protobuf:"fixed32,6,opt,name=impact,proto3" json:"impact,omitempty"` // Count of waived nodes that executed the control. Waived int32 `protobuf:"varint,7,opt,name=waived,proto3" json:"waived,omitempty"` // contains filtered or unexported fields }
func (*ControlStats) Descriptor
deprecated
func (*ControlStats) Descriptor() ([]byte, []int)
Deprecated: Use ControlStats.ProtoReflect.Descriptor instead.
func (*ControlStats) GetControl ¶
func (x *ControlStats) GetControl() string
func (*ControlStats) GetFailed ¶
func (x *ControlStats) GetFailed() int32
func (*ControlStats) GetImpact ¶
func (x *ControlStats) GetImpact() float32
func (*ControlStats) GetPassed ¶
func (x *ControlStats) GetPassed() int32
func (*ControlStats) GetSkipped ¶
func (x *ControlStats) GetSkipped() int32
func (*ControlStats) GetTitle ¶
func (x *ControlStats) GetTitle() string
func (*ControlStats) GetWaived ¶
func (x *ControlStats) GetWaived() int32
func (*ControlStats) ProtoMessage ¶
func (*ControlStats) ProtoMessage()
func (*ControlStats) ProtoReflect ¶
func (x *ControlStats) ProtoReflect() protoreflect.Message
func (*ControlStats) Reset ¶
func (x *ControlStats) Reset()
func (*ControlStats) String ¶
func (x *ControlStats) String() string
type ControlsSummary ¶
type ControlsSummary struct { // The total number of failed controls in the reports. Failures int32 `protobuf:"varint,1,opt,name=failures,proto3" json:"failures,omitempty"` // The total number of failed controls with an impact between 0.4 and 0.7. Majors int32 `protobuf:"varint,2,opt,name=majors,proto3" json:"majors,omitempty"` // The total number of failed controls with an impact of 0.3 or less. Minors int32 `protobuf:"varint,3,opt,name=minors,proto3" json:"minors,omitempty"` // The total number of failed controls with an impact of 0.7 or higher. Criticals int32 `protobuf:"varint,4,opt,name=criticals,proto3" json:"criticals,omitempty"` // The total number of passed controls in the reports. Passed int32 `protobuf:"varint,5,opt,name=passed,proto3" json:"passed,omitempty"` // The total number of skipped controls in the reports. Skipped int32 `protobuf:"varint,6,opt,name=skipped,proto3" json:"skipped,omitempty"` // The total number of waived controls in the reports. Waived int32 `protobuf:"varint,7,opt,name=waived,proto3" json:"waived,omitempty"` // contains filtered or unexported fields }
Statistics for the controls executed in the compliance reports.
func (*ControlsSummary) Descriptor
deprecated
func (*ControlsSummary) Descriptor() ([]byte, []int)
Deprecated: Use ControlsSummary.ProtoReflect.Descriptor instead.
func (*ControlsSummary) GetCriticals ¶
func (x *ControlsSummary) GetCriticals() int32
func (*ControlsSummary) GetFailures ¶
func (x *ControlsSummary) GetFailures() int32
func (*ControlsSummary) GetMajors ¶
func (x *ControlsSummary) GetMajors() int32
func (*ControlsSummary) GetMinors ¶
func (x *ControlsSummary) GetMinors() int32
func (*ControlsSummary) GetPassed ¶
func (x *ControlsSummary) GetPassed() int32
func (*ControlsSummary) GetSkipped ¶
func (x *ControlsSummary) GetSkipped() int32
func (*ControlsSummary) GetWaived ¶
func (x *ControlsSummary) GetWaived() int32
func (*ControlsSummary) ProtoMessage ¶
func (*ControlsSummary) ProtoMessage()
func (*ControlsSummary) ProtoReflect ¶
func (x *ControlsSummary) ProtoReflect() protoreflect.Message
func (*ControlsSummary) Reset ¶
func (x *ControlsSummary) Reset()
func (*ControlsSummary) String ¶
func (x *ControlsSummary) String() string
type Empty ¶
type Empty struct {
// contains filtered or unexported fields
}
func (*Empty) Descriptor
deprecated
func (*Empty) ProtoMessage ¶
func (*Empty) ProtoMessage()
func (*Empty) ProtoReflect ¶
func (x *Empty) ProtoReflect() protoreflect.Message
type FailureSummary ¶
type FailureSummary struct { // Name of the object failing. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Total count of failures. Failures int32 `protobuf:"varint,2,opt,name=failures,proto3" json:"failures,omitempty"` // ID of the object, included if applicable. Id string `protobuf:"bytes,3,opt,name=id,proto3" json:"id,omitempty"` // Not used. Profile string `protobuf:"bytes,4,opt,name=profile,proto3" json:"profile,omitempty"` // contains filtered or unexported fields }
func (*FailureSummary) Descriptor
deprecated
func (*FailureSummary) Descriptor() ([]byte, []int)
Deprecated: Use FailureSummary.ProtoReflect.Descriptor instead.
func (*FailureSummary) GetFailures ¶
func (x *FailureSummary) GetFailures() int32
func (*FailureSummary) GetId ¶
func (x *FailureSummary) GetId() string
func (*FailureSummary) GetName ¶
func (x *FailureSummary) GetName() string
func (*FailureSummary) GetProfile ¶
func (x *FailureSummary) GetProfile() string
func (*FailureSummary) ProtoMessage ¶
func (*FailureSummary) ProtoMessage()
func (*FailureSummary) ProtoReflect ¶
func (x *FailureSummary) ProtoReflect() protoreflect.Message
func (*FailureSummary) Reset ¶
func (x *FailureSummary) Reset()
func (*FailureSummary) String ¶
func (x *FailureSummary) String() string
type Failures ¶
type Failures struct { // Top failed profiles across the infrastructure. Profiles []*FailureSummary `protobuf:"bytes,1,rep,name=profiles,proto3" json:"profiles,omitempty"` // Top failed platforms across the infrastructure. Platforms []*FailureSummary `protobuf:"bytes,2,rep,name=platforms,proto3" json:"platforms,omitempty"` // Top failed controls across the infrastructure. Controls []*FailureSummary `protobuf:"bytes,3,rep,name=controls,proto3" json:"controls,omitempty"` // Top failed environments across the infrastructure. Environments []*FailureSummary `protobuf:"bytes,4,rep,name=environments,proto3" json:"environments,omitempty"` // contains filtered or unexported fields }
func (*Failures) Descriptor
deprecated
func (*Failures) GetControls ¶
func (x *Failures) GetControls() []*FailureSummary
func (*Failures) GetEnvironments ¶
func (x *Failures) GetEnvironments() []*FailureSummary
func (*Failures) GetPlatforms ¶
func (x *Failures) GetPlatforms() []*FailureSummary
func (*Failures) GetProfiles ¶
func (x *Failures) GetProfiles() []*FailureSummary
func (*Failures) ProtoMessage ¶
func (*Failures) ProtoMessage()
func (*Failures) ProtoReflect ¶
func (x *Failures) ProtoReflect() protoreflect.Message
type GetNodesUsageCountRequest ¶
type GetNodesUsageCountRequest struct {
// contains filtered or unexported fields
}
func (*GetNodesUsageCountRequest) Descriptor
deprecated
func (*GetNodesUsageCountRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetNodesUsageCountRequest.ProtoReflect.Descriptor instead.
func (*GetNodesUsageCountRequest) ProtoMessage ¶
func (*GetNodesUsageCountRequest) ProtoMessage()
func (*GetNodesUsageCountRequest) ProtoReflect ¶
func (x *GetNodesUsageCountRequest) ProtoReflect() protoreflect.Message
func (*GetNodesUsageCountRequest) Reset ¶
func (x *GetNodesUsageCountRequest) Reset()
func (*GetNodesUsageCountRequest) String ¶
func (x *GetNodesUsageCountRequest) String() string
type GetNodesUsageCountResponse ¶
type GetNodesUsageCountResponse struct { // number of days since telematics was last posted DaysSinceLastPost int64 `protobuf:"varint,1,opt,name=days_since_last_post,json=daysSinceLastPost,proto3" json:"days_since_last_post,omitempty"` // unique nodes count in a duration NodeCnt int64 `protobuf:"varint,2,opt,name=node_cnt,json=nodeCnt,proto3" json:"node_cnt,omitempty"` // contains filtered or unexported fields }
func (*GetNodesUsageCountResponse) Descriptor
deprecated
func (*GetNodesUsageCountResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetNodesUsageCountResponse.ProtoReflect.Descriptor instead.
func (*GetNodesUsageCountResponse) GetDaysSinceLastPost ¶
func (x *GetNodesUsageCountResponse) GetDaysSinceLastPost() int64
func (*GetNodesUsageCountResponse) GetNodeCnt ¶
func (x *GetNodesUsageCountResponse) GetNodeCnt() int64
func (*GetNodesUsageCountResponse) ProtoMessage ¶
func (*GetNodesUsageCountResponse) ProtoMessage()
func (*GetNodesUsageCountResponse) ProtoReflect ¶
func (x *GetNodesUsageCountResponse) ProtoReflect() protoreflect.Message
func (*GetNodesUsageCountResponse) Reset ¶
func (x *GetNodesUsageCountResponse) Reset()
func (*GetNodesUsageCountResponse) String ¶
func (x *GetNodesUsageCountResponse) String() string
type ListFilter ¶
type ListFilter struct { // The list of values to filter on for the given type. We 'OR' between these fields. Values []string `protobuf:"bytes,20,rep,name=values,proto3" json:"values,omitempty"` // The field to filter on. Type string `protobuf:"bytes,21,opt,name=type,proto3" json:"type,omitempty"` // contains filtered or unexported fields }
func (*ListFilter) Descriptor
deprecated
func (*ListFilter) Descriptor() ([]byte, []int)
Deprecated: Use ListFilter.ProtoReflect.Descriptor instead.
func (*ListFilter) GetType ¶
func (x *ListFilter) GetType() string
func (*ListFilter) GetValues ¶
func (x *ListFilter) GetValues() []string
func (*ListFilter) ProtoMessage ¶
func (*ListFilter) ProtoMessage()
func (*ListFilter) ProtoReflect ¶
func (x *ListFilter) ProtoReflect() protoreflect.Message
func (*ListFilter) Reset ¶
func (x *ListFilter) Reset()
func (*ListFilter) String ¶
func (x *ListFilter) String() string
type NodeSummary ¶
type NodeSummary struct { // The total number of nodes that passed their compliance scans. Compliant int32 `protobuf:"varint,1,opt,name=compliant,proto3" json:"compliant,omitempty"` // The total number of nodes that skipped their compliance scans. Skipped int32 `protobuf:"varint,2,opt,name=skipped,proto3" json:"skipped,omitempty"` // The total number of nodes that failed their compliance scans. Noncompliant int32 `protobuf:"varint,3,opt,name=noncompliant,proto3" json:"noncompliant,omitempty"` // The total number of nodes that failed their compliance scan with one or more control of critical impact. HighRisk int32 `protobuf:"varint,4,opt,name=high_risk,json=highRisk,proto3" json:"high_risk,omitempty"` // The total number of nodes that failed their compliance scan with one or more control of major impact. MediumRisk int32 `protobuf:"varint,5,opt,name=medium_risk,json=mediumRisk,proto3" json:"medium_risk,omitempty"` // The total number of nodes that failed their compliance scan with one or more control of minor impact. LowRisk int32 `protobuf:"varint,6,opt,name=low_risk,json=lowRisk,proto3" json:"low_risk,omitempty"` // The total number of nodes with a waived compliance scan. Waived int32 `protobuf:"varint,7,opt,name=waived,proto3" json:"waived,omitempty"` // contains filtered or unexported fields }
Statistics about the nodes scanned in the compliance reports.
func (*NodeSummary) Descriptor
deprecated
func (*NodeSummary) Descriptor() ([]byte, []int)
Deprecated: Use NodeSummary.ProtoReflect.Descriptor instead.
func (*NodeSummary) GetCompliant ¶
func (x *NodeSummary) GetCompliant() int32
func (*NodeSummary) GetHighRisk ¶
func (x *NodeSummary) GetHighRisk() int32
func (*NodeSummary) GetLowRisk ¶
func (x *NodeSummary) GetLowRisk() int32
func (*NodeSummary) GetMediumRisk ¶
func (x *NodeSummary) GetMediumRisk() int32
func (*NodeSummary) GetNoncompliant ¶
func (x *NodeSummary) GetNoncompliant() int32
func (*NodeSummary) GetSkipped ¶
func (x *NodeSummary) GetSkipped() int32
func (*NodeSummary) GetWaived ¶
func (x *NodeSummary) GetWaived() int32
func (*NodeSummary) ProtoMessage ¶
func (*NodeSummary) ProtoMessage()
func (*NodeSummary) ProtoReflect ¶
func (x *NodeSummary) ProtoReflect() protoreflect.Message
func (*NodeSummary) Reset ¶
func (x *NodeSummary) Reset()
func (*NodeSummary) String ¶
func (x *NodeSummary) String() string
type Profile ¶
type Profile struct { // Set of statistics about the profiles executed in the reports. ProfileList []*ProfileList `protobuf:"bytes,1,rep,name=profile_list,json=profileList,proto3" json:"profile_list,omitempty"` // Intentionally blank. ProfileSummary *ProfileSummary `protobuf:"bytes,2,opt,name=profile_summary,json=profileSummary,proto3" json:"profile_summary,omitempty"` // Summary information about a specific profile's control results across the reports. ControlStats []*ControlStats `protobuf:"bytes,3,rep,name=control_stats,json=controlStats,proto3" json:"control_stats,omitempty"` // contains filtered or unexported fields }
func (*Profile) Descriptor
deprecated
func (*Profile) GetControlStats ¶
func (x *Profile) GetControlStats() []*ControlStats
func (*Profile) GetProfileList ¶
func (x *Profile) GetProfileList() []*ProfileList
func (*Profile) GetProfileSummary ¶
func (x *Profile) GetProfileSummary() *ProfileSummary
func (*Profile) ProtoMessage ¶
func (*Profile) ProtoMessage()
func (*Profile) ProtoReflect ¶
func (x *Profile) ProtoReflect() protoreflect.Message
type ProfileList ¶
type ProfileList struct { // The profile name. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // The profile SHA ID. Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"` // Total number of nodes that failed this profile. Failures int32 `protobuf:"varint,3,opt,name=failures,proto3" json:"failures,omitempty"` // Total number of failed nodes with major control failures that executed the profile. Majors int32 `protobuf:"varint,4,opt,name=majors,proto3" json:"majors,omitempty"` // Total number of failed nodes with minor control failures that executed the profile. Minors int32 `protobuf:"varint,5,opt,name=minors,proto3" json:"minors,omitempty"` // Total number of failed nodes with critical control failures that executed the profile. Criticals int32 `protobuf:"varint,6,opt,name=criticals,proto3" json:"criticals,omitempty"` // Total number of passed nodes that executed the profile. Passed int32 `protobuf:"varint,7,opt,name=passed,proto3" json:"passed,omitempty"` // Total number of skipped nodes that executed the profile. Skipped int32 `protobuf:"varint,8,opt,name=skipped,proto3" json:"skipped,omitempty"` // Total number of waived nodes that executed the profile. Waived int32 `protobuf:"varint,9,opt,name=waived,proto3" json:"waived,omitempty"` // contains filtered or unexported fields }
func (*ProfileList) Descriptor
deprecated
func (*ProfileList) Descriptor() ([]byte, []int)
Deprecated: Use ProfileList.ProtoReflect.Descriptor instead.
func (*ProfileList) GetCriticals ¶
func (x *ProfileList) GetCriticals() int32
func (*ProfileList) GetFailures ¶
func (x *ProfileList) GetFailures() int32
func (*ProfileList) GetId ¶
func (x *ProfileList) GetId() string
func (*ProfileList) GetMajors ¶
func (x *ProfileList) GetMajors() int32
func (*ProfileList) GetMinors ¶
func (x *ProfileList) GetMinors() int32
func (*ProfileList) GetName ¶
func (x *ProfileList) GetName() string
func (*ProfileList) GetPassed ¶
func (x *ProfileList) GetPassed() int32
func (*ProfileList) GetSkipped ¶
func (x *ProfileList) GetSkipped() int32
func (*ProfileList) GetWaived ¶
func (x *ProfileList) GetWaived() int32
func (*ProfileList) ProtoMessage ¶
func (*ProfileList) ProtoMessage()
func (*ProfileList) ProtoReflect ¶
func (x *ProfileList) ProtoReflect() protoreflect.Message
func (*ProfileList) Reset ¶
func (x *ProfileList) Reset()
func (*ProfileList) String ¶
func (x *ProfileList) String() string
type ProfileSummary ¶
type ProfileSummary struct { // Name of the profile. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Title of the profile. Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"` // Version of the profile. Version string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"` // License info for the profile. License string `protobuf:"bytes,4,opt,name=license,proto3" json:"license,omitempty"` // Maintainer for the profile. Maintainer string `protobuf:"bytes,5,opt,name=maintainer,proto3" json:"maintainer,omitempty"` // Copyright info for the profile. Copyright string `protobuf:"bytes,6,opt,name=copyright,proto3" json:"copyright,omitempty"` // Copyright email info for the profile. CopyrightEmail string `protobuf:"bytes,7,opt,name=copyright_email,json=copyrightEmail,proto3" json:"copyright_email,omitempty"` // Summary description of the profile. Summary string `protobuf:"bytes,8,opt,name=summary,proto3" json:"summary,omitempty"` // Supports information for the profile (which os it can run on). Supports []*Support `protobuf:"bytes,9,rep,name=supports,proto3" json:"supports,omitempty"` // Intentionally blank. Stats *ProfileSummaryStats `protobuf:"bytes,10,opt,name=stats,proto3" json:"stats,omitempty"` // Dependency information about the profile (which profiles it inherits). Depends []*reporting.Dependency `protobuf:"bytes,11,rep,name=depends,proto3" json:"depends,omitempty"` // contains filtered or unexported fields }
Summary information about a specific profile's execution across the reports.
func (*ProfileSummary) Descriptor
deprecated
func (*ProfileSummary) Descriptor() ([]byte, []int)
Deprecated: Use ProfileSummary.ProtoReflect.Descriptor instead.
func (*ProfileSummary) GetCopyright ¶
func (x *ProfileSummary) GetCopyright() string
func (*ProfileSummary) GetCopyrightEmail ¶
func (x *ProfileSummary) GetCopyrightEmail() string
func (*ProfileSummary) GetDepends ¶
func (x *ProfileSummary) GetDepends() []*reporting.Dependency
func (*ProfileSummary) GetLicense ¶
func (x *ProfileSummary) GetLicense() string
func (*ProfileSummary) GetMaintainer ¶
func (x *ProfileSummary) GetMaintainer() string
func (*ProfileSummary) GetName ¶
func (x *ProfileSummary) GetName() string
func (*ProfileSummary) GetStats ¶
func (x *ProfileSummary) GetStats() *ProfileSummaryStats
func (*ProfileSummary) GetSummary ¶
func (x *ProfileSummary) GetSummary() string
func (*ProfileSummary) GetSupports ¶
func (x *ProfileSummary) GetSupports() []*Support
func (*ProfileSummary) GetTitle ¶
func (x *ProfileSummary) GetTitle() string
func (*ProfileSummary) GetVersion ¶
func (x *ProfileSummary) GetVersion() string
func (*ProfileSummary) ProtoMessage ¶
func (*ProfileSummary) ProtoMessage()
func (*ProfileSummary) ProtoReflect ¶
func (x *ProfileSummary) ProtoReflect() protoreflect.Message
func (*ProfileSummary) Reset ¶
func (x *ProfileSummary) Reset()
func (*ProfileSummary) String ¶
func (x *ProfileSummary) String() string
type ProfileSummaryStats ¶
type ProfileSummaryStats struct { // Total number of failed nodes that executed the profile. Failed int32 `protobuf:"varint,1,opt,name=failed,proto3" json:"failed,omitempty"` // Total number of passed nodes that executed the profile. Passed int32 `protobuf:"varint,2,opt,name=passed,proto3" json:"passed,omitempty"` // Total number of skipped nodes that executed the profile. Skipped int32 `protobuf:"varint,3,opt,name=skipped,proto3" json:"skipped,omitempty"` // Not used. FailedNodes int32 `protobuf:"varint,4,opt,name=failed_nodes,json=failedNodes,proto3" json:"failed_nodes,omitempty"` // Not used. TotalNodes int32 `protobuf:"varint,5,opt,name=total_nodes,json=totalNodes,proto3" json:"total_nodes,omitempty"` // Total number of waived controls for the given profile across nodes. Waived int32 `protobuf:"varint,6,opt,name=waived,proto3" json:"waived,omitempty"` // contains filtered or unexported fields }
Statistics about the nodes that executed the profile.
func (*ProfileSummaryStats) Descriptor
deprecated
func (*ProfileSummaryStats) Descriptor() ([]byte, []int)
Deprecated: Use ProfileSummaryStats.ProtoReflect.Descriptor instead.
func (*ProfileSummaryStats) GetFailed ¶
func (x *ProfileSummaryStats) GetFailed() int32
func (*ProfileSummaryStats) GetFailedNodes ¶
func (x *ProfileSummaryStats) GetFailedNodes() int32
func (*ProfileSummaryStats) GetPassed ¶
func (x *ProfileSummaryStats) GetPassed() int32
func (*ProfileSummaryStats) GetSkipped ¶
func (x *ProfileSummaryStats) GetSkipped() int32
func (*ProfileSummaryStats) GetTotalNodes ¶
func (x *ProfileSummaryStats) GetTotalNodes() int32
func (*ProfileSummaryStats) GetWaived ¶
func (x *ProfileSummaryStats) GetWaived() int32
func (*ProfileSummaryStats) ProtoMessage ¶
func (*ProfileSummaryStats) ProtoMessage()
func (*ProfileSummaryStats) ProtoReflect ¶
func (x *ProfileSummaryStats) ProtoReflect() protoreflect.Message
func (*ProfileSummaryStats) Reset ¶
func (x *ProfileSummaryStats) Reset()
func (*ProfileSummaryStats) String ¶
func (x *ProfileSummaryStats) String() string
type Query ¶
type Query struct { // Unique identifier, such as a profile ID. Id string `protobuf:"bytes,17,opt,name=id,proto3" json:"id,omitempty"` // Type of data being requested, used for ReadTrend and ReadSummary. Type string `protobuf:"bytes,19,opt,name=type,proto3" json:"type,omitempty"` // The number of results to return (used when pagination is not supported). Size int32 `protobuf:"varint,18,opt,name=size,proto3" json:"size,omitempty"` // The interval to use for ReadTrend results, in integer seconds. Default of one hour, 3600. Interval int32 `protobuf:"varint,25,opt,name=interval,proto3" json:"interval,omitempty"` // Filters applied to the results. Filters []*ListFilter `protobuf:"bytes,20,rep,name=filters,proto3" json:"filters,omitempty"` Order Query_OrderType `` /* 134-byte string literal not displayed */ // Sort the list of results by a field. Sort string `protobuf:"bytes,22,opt,name=sort,proto3" json:"sort,omitempty"` // The offset for paginating requests. An offset defines a place in the results in order to fetch the next page of the results. Page int32 `protobuf:"varint,23,opt,name=page,proto3" json:"page,omitempty"` // The number of results on each paginated request page. PerPage int32 `protobuf:"varint,24,opt,name=per_page,json=perPage,proto3" json:"per_page,omitempty"` // contains filtered or unexported fields }
func (*Query) Descriptor
deprecated
func (*Query) GetFilters ¶
func (x *Query) GetFilters() []*ListFilter
func (*Query) GetInterval ¶
func (*Query) GetOrder ¶
func (x *Query) GetOrder() Query_OrderType
func (*Query) GetPerPage ¶
func (*Query) ProtoMessage ¶
func (*Query) ProtoMessage()
func (*Query) ProtoReflect ¶
func (x *Query) ProtoReflect() protoreflect.Message
type Query_OrderType ¶
type Query_OrderType int32
Sort the results in ascending or descending order.
const ( Query_ASC Query_OrderType = 0 Query_DESC Query_OrderType = 1 )
func (Query_OrderType) Descriptor ¶
func (Query_OrderType) Descriptor() protoreflect.EnumDescriptor
func (Query_OrderType) Enum ¶
func (x Query_OrderType) Enum() *Query_OrderType
func (Query_OrderType) EnumDescriptor
deprecated
func (Query_OrderType) EnumDescriptor() ([]byte, []int)
Deprecated: Use Query_OrderType.Descriptor instead.
func (Query_OrderType) Number ¶
func (x Query_OrderType) Number() protoreflect.EnumNumber
func (Query_OrderType) String ¶
func (x Query_OrderType) String() string
func (Query_OrderType) Type ¶
func (Query_OrderType) Type() protoreflect.EnumType
type ReportSummary ¶
type ReportSummary struct { // Overall aggregated status for all the reports. Status string `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"` // Not used. Duration float64 `protobuf:"fixed64,2,opt,name=duration,proto3" json:"duration,omitempty"` // Not used. StartDate string `protobuf:"bytes,3,opt,name=start_date,json=startDate,proto3" json:"start_date,omitempty"` // Intentionally blank. Stats *Stats `protobuf:"bytes,4,opt,name=stats,proto3" json:"stats,omitempty"` // contains filtered or unexported fields }
Statistics on the overall compliance reports.
func (*ReportSummary) Descriptor
deprecated
func (*ReportSummary) Descriptor() ([]byte, []int)
Deprecated: Use ReportSummary.ProtoReflect.Descriptor instead.
func (*ReportSummary) GetDuration ¶
func (x *ReportSummary) GetDuration() float64
func (*ReportSummary) GetStartDate ¶
func (x *ReportSummary) GetStartDate() string
func (*ReportSummary) GetStats ¶
func (x *ReportSummary) GetStats() *Stats
func (*ReportSummary) GetStatus ¶
func (x *ReportSummary) GetStatus() string
func (*ReportSummary) ProtoMessage ¶
func (*ReportSummary) ProtoMessage()
func (*ReportSummary) ProtoReflect ¶
func (x *ReportSummary) ProtoReflect() protoreflect.Message
func (*ReportSummary) Reset ¶
func (x *ReportSummary) Reset()
func (*ReportSummary) String ¶
func (x *ReportSummary) String() string
type Stats ¶
type Stats struct { // Deprecated. int64 types render into string types when serialized to satisfy all browsers // Replaced by the `nodes_cnt` field // // Deprecated: Do not use. Nodes int64 `protobuf:"varint,1,opt,name=nodes,proto3" json:"nodes,omitempty"` // The number of unique node platforms in the reports. Platforms int32 `protobuf:"varint,2,opt,name=platforms,proto3" json:"platforms,omitempty"` // The number of unique environments in the reports. Environments int32 `protobuf:"varint,3,opt,name=environments,proto3" json:"environments,omitempty"` // The number of unique profiles in the reports. Profiles int32 `protobuf:"varint,4,opt,name=profiles,proto3" json:"profiles,omitempty"` // The number of unique nodes scanned in the reports. NodesCnt int32 `protobuf:"varint,5,opt,name=nodes_cnt,json=nodesCnt,proto3" json:"nodes_cnt,omitempty"` // The number of unique controls scanned in the reports. Controls int32 `protobuf:"varint,6,opt,name=controls,proto3" json:"controls,omitempty"` // contains filtered or unexported fields }
General statistics about the reports.
func (*Stats) Descriptor
deprecated
func (*Stats) GetControls ¶
func (*Stats) GetEnvironments ¶
func (*Stats) GetNodesCnt ¶
func (*Stats) GetPlatforms ¶
func (*Stats) GetProfiles ¶
func (*Stats) ProtoMessage ¶
func (*Stats) ProtoMessage()
func (*Stats) ProtoReflect ¶
func (x *Stats) ProtoReflect() protoreflect.Message
type StatsServiceClient ¶
type StatsServiceClient interface { // Read Summary // // Returns summary statistics for compliance reports. // General report summary information is the default. // Adding a `type` value of `nodes` or `controls` will return summary statistics for that object. // Supports filtering. // // The API supports date range filters when `end_time` is the current time // and `start_time` is any time in last 90 days. In case, the `end_time` is any // date other than the current date, the API would return data only for the `end_time`. // // Example: // “` // { // "type":"nodes", // "filters":[ // {"type":"environment","values":["dev*"]}, // {"type":"start_time","values":["2019-10-26T00:00:00Z"]}, // {"type":"end_time","values":["2019-11-05T23:59:59Z"]} // ] // } // “` // // Authorization Action: // “` // “` // //compliance:reportSummary:get ReadSummary(ctx context.Context, in *Query, opts ...grpc.CallOption) (*Summary, error) // Read Trend // // Returns trendgraph statistics for compliance reports. // The `type` field is required for this api call. Options are `nodes` or `controls`. // Requires minimum `interval` field of 3600 and defined start time and end time filters. // Supports filtering. // // Example: // “` // { // "type":"nodes", // "interval":86400, // "filters":[ // {"type":"environment","values":["dev*"]}, // {"type":"start_time","values":["2019-10-26T00:00:00Z"]}, // {"type":"end_time","values":["2019-11-05T23:59:59Z"]} // ] // } // “` // // Authorization Action: // “` // “` // //compliance:reportTrend:get ReadTrend(ctx context.Context, in *Query, opts ...grpc.CallOption) (*Trends, error) // Read Profiles // // Returns statistics and summary information for profiles executed as part of the compliance reports. // If called without specifying a profile ID (`id`), the API will return stats on all the profiles. // If the `id` field is provided (profile ID) as part of the query object, the `type` field must also be specified. Options are `controls` or `summary`. // Supports filtering. // // “` // { // "type":"controls", // "id":"09adcbb3b9b3233d5de63cd98a5ba3e155b3aaeb66b5abed379f5fb1ff143988", // "filters":[ // {"type":"environment","values":["dev*"]}, // {"type":"start_time","values":["2019-10-26T00:00:00Z"]}, // {"type":"end_time","values":["2019-11-05T23:59:59Z"]} // ] // } // “` // // Authorization Action: // “` // “` // //compliance:reportProfiles:get ReadProfiles(ctx context.Context, in *Query, opts ...grpc.CallOption) (*Profile, error) // Read Failures // // Returns the top failures for the specified object. A types filter is required for this api. // Supported values are `platform`, `environment`, `control`, and `profile`. // By default, the top ten failed objects for the specified type are returned. // Supports filtering and respects `size` parameter. // // Example: // “` // { // "filters":[ // {"type":"start_time","values":["2019-10-26T00:00:00Z"]}, // {"type":"end_time","values":["2019-11-05T23:59:59Z"]}, // {"type":"types","values":["platform","environment"]} // ] // } // “` // // Authorization Action: // “` // “` // //compliance:reportFailures:get ReadFailures(ctx context.Context, in *Query, opts ...grpc.CallOption) (*Failures, error) // UpdateTelemetryReported // // # Acknowledge API to updates the last complaince telemetry reported date in postgres // // Authorization Action: // “` // “` // //iam:introspect:getAll UpdateTelemetryReported(ctx context.Context, in *UpdateTelemetryReportedRequest, opts ...grpc.CallOption) (*UpdateTelemetryReportedResponse, error) // GetNodesUsageCount // // Returns the count of unique nodes with lastRun in a given time. // The time duration can be between the last time Telemetry data sent and the day before the current date. // If the duration < 15 days --> 15 days // duration > 15 days --> duration // // Authorization Action: // “` // “` // //iam:introspect:getAll GetNodesUsageCount(ctx context.Context, in *GetNodesUsageCountRequest, opts ...grpc.CallOption) (*GetNodesUsageCountResponse, error) }
StatsServiceClient is the client API for StatsService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewStatsServiceClient ¶
func NewStatsServiceClient(cc grpc.ClientConnInterface) StatsServiceClient
type StatsServiceServer ¶
type StatsServiceServer interface { // Read Summary // // Returns summary statistics for compliance reports. // General report summary information is the default. // Adding a `type` value of `nodes` or `controls` will return summary statistics for that object. // Supports filtering. // // The API supports date range filters when `end_time` is the current time // and `start_time` is any time in last 90 days. In case, the `end_time` is any // date other than the current date, the API would return data only for the `end_time`. // // Example: // “` // { // "type":"nodes", // "filters":[ // {"type":"environment","values":["dev*"]}, // {"type":"start_time","values":["2019-10-26T00:00:00Z"]}, // {"type":"end_time","values":["2019-11-05T23:59:59Z"]} // ] // } // “` // // Authorization Action: // “` // “` // //compliance:reportSummary:get ReadSummary(context.Context, *Query) (*Summary, error) // Read Trend // // Returns trendgraph statistics for compliance reports. // The `type` field is required for this api call. Options are `nodes` or `controls`. // Requires minimum `interval` field of 3600 and defined start time and end time filters. // Supports filtering. // // Example: // “` // { // "type":"nodes", // "interval":86400, // "filters":[ // {"type":"environment","values":["dev*"]}, // {"type":"start_time","values":["2019-10-26T00:00:00Z"]}, // {"type":"end_time","values":["2019-11-05T23:59:59Z"]} // ] // } // “` // // Authorization Action: // “` // “` // //compliance:reportTrend:get ReadTrend(context.Context, *Query) (*Trends, error) // Read Profiles // // Returns statistics and summary information for profiles executed as part of the compliance reports. // If called without specifying a profile ID (`id`), the API will return stats on all the profiles. // If the `id` field is provided (profile ID) as part of the query object, the `type` field must also be specified. Options are `controls` or `summary`. // Supports filtering. // // “` // { // "type":"controls", // "id":"09adcbb3b9b3233d5de63cd98a5ba3e155b3aaeb66b5abed379f5fb1ff143988", // "filters":[ // {"type":"environment","values":["dev*"]}, // {"type":"start_time","values":["2019-10-26T00:00:00Z"]}, // {"type":"end_time","values":["2019-11-05T23:59:59Z"]} // ] // } // “` // // Authorization Action: // “` // “` // //compliance:reportProfiles:get ReadProfiles(context.Context, *Query) (*Profile, error) // Read Failures // // Returns the top failures for the specified object. A types filter is required for this api. // Supported values are `platform`, `environment`, `control`, and `profile`. // By default, the top ten failed objects for the specified type are returned. // Supports filtering and respects `size` parameter. // // Example: // “` // { // "filters":[ // {"type":"start_time","values":["2019-10-26T00:00:00Z"]}, // {"type":"end_time","values":["2019-11-05T23:59:59Z"]}, // {"type":"types","values":["platform","environment"]} // ] // } // “` // // Authorization Action: // “` // “` // //compliance:reportFailures:get ReadFailures(context.Context, *Query) (*Failures, error) // UpdateTelemetryReported // // # Acknowledge API to updates the last complaince telemetry reported date in postgres // // Authorization Action: // “` // “` // //iam:introspect:getAll UpdateTelemetryReported(context.Context, *UpdateTelemetryReportedRequest) (*UpdateTelemetryReportedResponse, error) // GetNodesUsageCount // // Returns the count of unique nodes with lastRun in a given time. // The time duration can be between the last time Telemetry data sent and the day before the current date. // If the duration < 15 days --> 15 days // duration > 15 days --> duration // // Authorization Action: // “` // “` // //iam:introspect:getAll GetNodesUsageCount(context.Context, *GetNodesUsageCountRequest) (*GetNodesUsageCountResponse, error) }
StatsServiceServer is the server API for StatsService service.
type Summary ¶
type Summary struct { // Intentionally blank. ControlsSummary *ControlsSummary `protobuf:"bytes,1,opt,name=controls_summary,json=controlsSummary,proto3" json:"controls_summary,omitempty"` // Intentionally blank. NodeSummary *NodeSummary `protobuf:"bytes,2,opt,name=node_summary,json=nodeSummary,proto3" json:"node_summary,omitempty"` // Intentionally blank. ReportSummary *ReportSummary `protobuf:"bytes,3,opt,name=report_summary,json=reportSummary,proto3" json:"report_summary,omitempty"` // contains filtered or unexported fields }
func (*Summary) Descriptor
deprecated
func (*Summary) GetControlsSummary ¶
func (x *Summary) GetControlsSummary() *ControlsSummary
func (*Summary) GetNodeSummary ¶
func (x *Summary) GetNodeSummary() *NodeSummary
func (*Summary) GetReportSummary ¶
func (x *Summary) GetReportSummary() *ReportSummary
func (*Summary) ProtoMessage ¶
func (*Summary) ProtoMessage()
func (*Summary) ProtoReflect ¶
func (x *Summary) ProtoReflect() protoreflect.Message
type Support ¶
type Support struct { // OS Name compatible with the profile. This is legacy InSpec syntax. OsName string `protobuf:"bytes,1,opt,name=os_name,json=os-name,proto3" json:"os_name,omitempty"` // OS Family compatible with the profile. This is legacy InSpec syntax. OsFamily string `protobuf:"bytes,2,opt,name=os_family,json=os-family,proto3" json:"os_family,omitempty"` // OS Release compatible with the profile. Release string `protobuf:"bytes,3,opt,name=release,proto3" json:"release,omitempty"` // InSpec Version compatible with the profile. InspecVersion string `protobuf:"bytes,4,opt,name=inspec_version,json=inspecVersion,proto3" json:"inspec_version,omitempty"` // Platform Name compatible with the profile. PlatformName string `protobuf:"bytes,5,opt,name=platform_name,json=platform-name,proto3" json:"platform_name,omitempty"` // Platform Family compatible with the profile. PlatformFamily string `protobuf:"bytes,6,opt,name=platform_family,json=platform-family,proto3" json:"platform_family,omitempty"` // Platform compatible with the profile. Platform string `protobuf:"bytes,7,opt,name=platform,proto3" json:"platform,omitempty"` // contains filtered or unexported fields }
func (*Support) Descriptor
deprecated
func (*Support) GetInspecVersion ¶
func (*Support) GetOsFamily ¶
func (*Support) GetPlatform ¶
func (*Support) GetPlatformFamily ¶
func (*Support) GetPlatformName ¶
func (*Support) GetRelease ¶
func (*Support) ProtoMessage ¶
func (*Support) ProtoMessage()
func (*Support) ProtoReflect ¶
func (x *Support) ProtoReflect() protoreflect.Message
type Trend ¶
type Trend struct { // Time in point for which the passed/failed/skipped data is valid. ReportTime string `protobuf:"bytes,1,opt,name=report_time,json=reportTime,proto3" json:"report_time,omitempty"` // Total passed objects (nodes or controls) on the reports at the given report time. Passed int32 `protobuf:"varint,2,opt,name=passed,proto3" json:"passed,omitempty"` // Total failed objects (nodes or controls) on the reports at the given report time. Failed int32 `protobuf:"varint,3,opt,name=failed,proto3" json:"failed,omitempty"` // Total skipped objects (nodes or controls) on the reports at the given report time. Skipped int32 `protobuf:"varint,4,opt,name=skipped,proto3" json:"skipped,omitempty"` // Total waived objects (nodes or controls) on the reports at the given report time. Waived int32 `protobuf:"varint,5,opt,name=waived,proto3" json:"waived,omitempty"` // contains filtered or unexported fields }
func (*Trend) Descriptor
deprecated
func (*Trend) GetReportTime ¶
func (*Trend) GetSkipped ¶
func (*Trend) ProtoMessage ¶
func (*Trend) ProtoMessage()
func (*Trend) ProtoReflect ¶
func (x *Trend) ProtoReflect() protoreflect.Message
type Trends ¶
type Trends struct { // Set of statistics for passed/failed/skipped nodes or controls in a trendgraph friendly data format. Trends []*Trend `protobuf:"bytes,1,rep,name=trends,proto3" json:"trends,omitempty"` // contains filtered or unexported fields }
func (*Trends) Descriptor
deprecated
func (*Trends) ProtoMessage ¶
func (*Trends) ProtoMessage()
func (*Trends) ProtoReflect ¶
func (x *Trends) ProtoReflect() protoreflect.Message
type UnimplementedStatsServiceServer ¶
type UnimplementedStatsServiceServer struct { }
UnimplementedStatsServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedStatsServiceServer) GetNodesUsageCount ¶
func (*UnimplementedStatsServiceServer) GetNodesUsageCount(context.Context, *GetNodesUsageCountRequest) (*GetNodesUsageCountResponse, error)
func (*UnimplementedStatsServiceServer) ReadFailures ¶
func (*UnimplementedStatsServiceServer) ReadProfiles ¶
func (*UnimplementedStatsServiceServer) ReadSummary ¶
func (*UnimplementedStatsServiceServer) UpdateTelemetryReported ¶
func (*UnimplementedStatsServiceServer) UpdateTelemetryReported(context.Context, *UpdateTelemetryReportedRequest) (*UpdateTelemetryReportedResponse, error)
type UpdateTelemetryReportedRequest ¶
type UpdateTelemetryReportedRequest struct { // last complaince telemetry reported date LastTelemetryReportedAt string `` /* 134-byte string literal not displayed */ // contains filtered or unexported fields }
func (*UpdateTelemetryReportedRequest) Descriptor
deprecated
func (*UpdateTelemetryReportedRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateTelemetryReportedRequest.ProtoReflect.Descriptor instead.
func (*UpdateTelemetryReportedRequest) GetLastTelemetryReportedAt ¶
func (x *UpdateTelemetryReportedRequest) GetLastTelemetryReportedAt() string
func (*UpdateTelemetryReportedRequest) ProtoMessage ¶
func (*UpdateTelemetryReportedRequest) ProtoMessage()
func (*UpdateTelemetryReportedRequest) ProtoReflect ¶
func (x *UpdateTelemetryReportedRequest) ProtoReflect() protoreflect.Message
func (*UpdateTelemetryReportedRequest) Reset ¶
func (x *UpdateTelemetryReportedRequest) Reset()
func (*UpdateTelemetryReportedRequest) String ¶
func (x *UpdateTelemetryReportedRequest) String() string
type UpdateTelemetryReportedResponse ¶
type UpdateTelemetryReportedResponse struct {
// contains filtered or unexported fields
}
func (*UpdateTelemetryReportedResponse) Descriptor
deprecated
func (*UpdateTelemetryReportedResponse) Descriptor() ([]byte, []int)
Deprecated: Use UpdateTelemetryReportedResponse.ProtoReflect.Descriptor instead.
func (*UpdateTelemetryReportedResponse) ProtoMessage ¶
func (*UpdateTelemetryReportedResponse) ProtoMessage()
func (*UpdateTelemetryReportedResponse) ProtoReflect ¶
func (x *UpdateTelemetryReportedResponse) ProtoReflect() protoreflect.Message
func (*UpdateTelemetryReportedResponse) Reset ¶
func (x *UpdateTelemetryReportedResponse) Reset()
func (*UpdateTelemetryReportedResponse) String ¶
func (x *UpdateTelemetryReportedResponse) String() string