Package errs provides common error types that can be used across the application.

Package legacy provides types for legacy/deprecated APIs.

Package metric03 holds the structure for the old mskpack cmetrics version 0.3.x.

NewPipelineObjectsParams creates and returns a new PipelineObjectsParams object based on the "include" parameter in the given request.

ValidCheckProtocol checks if the given status is a valid check protocol.

ValidCheckStatus checks if the given string is a valid check status.

ValidClusterObjectKind checks if the given status is a valid cluster object type.

AgentArchArm is for arm machines.

AgentArchArm64 is for arm64 machines.

AgentArchUnknown is the default value for architecture.

AgentArchX86 is for intel i686 machines.

AgentArchX86_64 is for intel x86_64 machines.

AgentEditionCommunity fluent community edition.

AgentEditionEnterprise fluent enterprise edition.

AgentOSFreeBSD is for FreeBSD machines.

AgentOSLinux is for Win32 machines.

AgentOSMacOS is for macOS machines.

AgentOSNetBSD is for NetBSD machines.

AgentOSOpenBSD is for OpenBSD machines.

AgentOSUnknown is the default value for the operating system.

AgentOSWindows is for Win32 machines.

AgentTypeFluentBit fluentbit agent type.

AgentTypeFluentd fluentd agent type.

CoreInstanceNextPing is the time between pings to a core instance.

CoreInstanceNextPingDelta is the extra time acceptable for a ping to be delayed.

CoreInstanceNextPingTimeout is the time after a core instance is considered "unreachable".

DefaultResourceProfileName is the default resource profile used when creating pipelines.

IngestCheckDefaultTimeout default timeout for an ingest check.

10MiB.

LogSelectorKindKey matches a log using some of its keys.

LogSelectorOpKindEqual matches a log key/value equally.

MembershipRoleAdmin admin membership role.

MembershipRoleCreator creator membership role.

https://github.com/fluent/fluent-bit/blob/9d9ac68a2b45a4cedeafbf7c5aba513f494eced6/lib/cmetrics/include/cmetrics/cmetrics.h#L32-L34.

https://github.com/fluent/fluent-bit/blob/9d9ac68a2b45a4cedeafbf7c5aba513f494eced6/lib/cmetrics/include/cmetrics/cmetrics.h#L32-L34.

https://github.com/fluent/fluent-bit/blob/9d9ac68a2b45a4cedeafbf7c5aba513f494eced6/lib/cmetrics/include/cmetrics/cmetrics.h#L32-L34.

https://github.com/fluent/fluent-bit/blob/9d9ac68a2b45a4cedeafbf7c5aba513f494eced6/lib/cmetrics/include/cmetrics/cmetrics.h#L26-L30.

https://github.com/fluent/fluent-bit/blob/9d9ac68a2b45a4cedeafbf7c5aba513f494eced6/lib/cmetrics/include/cmetrics/cmetrics.h#L26-L30.

https://github.com/fluent/fluent-bit/blob/9d9ac68a2b45a4cedeafbf7c5aba513f494eced6/lib/cmetrics/include/cmetrics/cmetrics.h#L26-L30.

https://github.com/fluent/fluent-bit/blob/9d9ac68a2b45a4cedeafbf7c5aba513f494eced6/lib/cmetrics/include/cmetrics/cmetrics.h#L26-L30.

https://github.com/fluent/fluent-bit/blob/9d9ac68a2b45a4cedeafbf7c5aba513f494eced6/lib/cmetrics/include/cmetrics/cmetrics.h#L26-L30.

PipelineStatusChecksFailed PipelineStatusCheckFailed is the status marked when any of the checks associated with a pipeline FAIL.

PipelineStatusChecksOK is the status marked when all the checks associated with a pipeline are OK.

PipelineStatusFailed is the status when a pipeline fails.

PipelineStatusNew is the default status right after a pipeline is created.

PipelineStatusScaling is the status of a pipeline while scaling up/down.

PipelineStatusStarted is the status of a started pipeline.

PipelineStatusStarting is the status of a starting pipeline.

ProcessingRuleLanguageLua will produce a filter in Lua.

ResourceProfileBestEffortLowResource is one of the 3 default resource profiles created with an aggregator.

ResourceProfileHighPerformanceGuaranteedDelivery is one of the 3 default resource profiles created with an aggregator.

ResourceProfileHighPerformanceOptimalThroughput is one of the 3 default resource profiles created with an aggregator.

RuleActionKindAdd adds a key-value pair to the log record.

RuleActionKindCopy copies the matching key into the new key.

RuleActionKindMask causes the value associated with the matching key to be replaced with `redacted`.

RuleActionKindRemove removes a key-value pair from the log record using its key.

RuleActionKindRename renames the matching key into the new key.

RuleActionKindSkip causes a log record to be skipped entirely using its key.

AllPipelineKindTypes all valid pipeline kinds.

AllPipelinePortProtocols all valid protocol types for a pipeline.

AllValidCheckProtocols all valid protocols for checks.

AllValidCheckStatuses all valid statuses for checks.

AcceptInvitation request payload for accepting a project invitation.

Agent model.

AgentConfig model.

AgentConfigHistory paginated list.

AgentConfigHistoryParams request payload for querying the agent config history.

AgentError represent an error that occurred on an agent.

Agents paginated list.

AgentsParams request payload for querying agents.

Check base check model.

ClusterObject type for core_instance cluster objects.

ClusterObjectParams request payload for querying the core_instance cluster objects.

ClusterObjects paginated list.

ConfigSection model represents a fluent-bit config section that can be reused across pipelines on a project.

ConfigSections paginated list.

ConfigSectionsParams request payload for querying the fluent-bit config sections.

CoreInstance model.

CoreInstanceCheck type for pipeline level checks.

CoreInstanceChecks paginated list.

CoreInstanceChecksParams request payload for querying the core_instance checks.

CoreInstanceMetadata See: https://github.com/fluent/fluent-bit/blob/d059a5a5dca6aff4ff5d0694887355480d6f2c1d/plugins/out_calyptia/calyptia.c#L206-L229 Those are the only supported metadata fields that will be marshaled by the Calyptia Cloud API, please send a PR if further fields are required.

CoreInstancePingResponse response from a core instance ping call.

CoreInstances paginated list.

CoreInstancesParams request payload for querying core instances.

CreateClusterObject request payload for creating a core_instance cluster object.

CreateConfigSection request payload for creating a new fluent-bit config section on a project.

CreateCoreInstance request payload for creating a new core instance.

CreatedCoreInstance response payload after creating a core instance successfully.

CreatedFluentBitPluginConfig response payload after creating a fluent-bit plugin config successfully.

CreatedMetrics response model for created agent metrics.

CreatedPipeline response payload after creating a pipeline successfully.

CreatedPipelinePort response payload after creating a pipeline port successfully.

CreatedProcessingRule response payload.

CreatedProject response payload after creating a project successfully.

CreatedTraceRecord response payload after creating an session record successfully.

CreateFleetFile request payload for creating a new fleet file.

CreateFluentBitPluginConfig request payload for creating a new fluent-bit plugin config on a project.

CreateIngestCheck request payload for creating a core_instance ingestion check.

CreateInvitation request payload for creating a project invitation.

CreateMetrics types defined by fluent-bit cmetrics v0.5.x.

CreatePipeline request payload for creating a new pipeline.

CreatePipelineFile request payload for creating a new pipeline file.

CreatePipelinePort request payload for creating a pipeline port.

CreatePipelineSecret request payload for creating a new pipeline secret.

CreateProcessingRule request payload.

CreateProject request payload for creating a project.

CreateResourceProfile request payload for creating a resource profile.

CreateToken request payload for creating a new token.

CreateTraceRecord payload for a single record in trace records.

CreateTraceSession request payload for creating a new trace session.

Error returned by the API.

FleetFile model.

FleetFiles paginated list.

FleetFilesParams request payload for querying the fleet files.

FleetParams request payload for querying a single fleet.

FluentBitLog is the Go representation of a fluent-bit log record.

FluentBitPluginConfig model represents a fluent-bit plugin that can be reused across pipelines on a project.

FluentBitPluginConfigs paginated list.

FluentBitPluginConfigsParams request payload for querying the fluent-bit plugin configs.

IngestCheck type for core_instance ingestion checks.

IngestChecks paginated list.

IngestChecksParams request payload for querying the core_instance ingestion checks.

Label model used internally for metrics.

LogAttr its the key-value pair in a log record.

LogSelector used to match a log entry.

Membership model.

Memberships paginated list.

MembersParams request payload for querying members.

MetadataAWS See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instancedata-data-retrieval.html.

MetadataGCP See: https://cloud.google.com/compute/docs/metadata/default-metadata-values.

MetadataK8S See: https://github.com/kubernetes/website/blob/60390ff3c0ef0043a58568ad2e4c2b7634028074/content/en/examples/pods/inject/dapi-volume.yaml#L5 For further cluster information data that can be included check: https://pkg.go.dev/k8s.io/client-go/discovery#DiscoveryClient.

MetricsFilter stores totals for a core instance filter.

MetricsInput stores totals for a core instance input.

MetricsOutput stores totals for a core instance output.

MetricsOverTime stores a list of metrics over time for a core instance.

MetricsOverTimeByPlugin stores a list of metrics over time for a core instance for a specific plugin.

MetricsOverTimeByPluginFilter stores a list of metrics over time for core instance filters organized by plugin.

MetricsOverTimeByPluginInput stores a list of metrics over time for core instance inputs organized by plugin.

MetricsOverTimeByPluginOutput stores a list of metrics over time for core instance outputs organized by plugin.

MetricsOverTimeFilter stores a list of metrics over time for a core instance filter.

MetricsOverTimeInput stores a list of metrics over time for a core instance input.

MetricsOverTimeOutput stores a list of metrics over time for a core instance output.

MetricsParams parameters to filtering metrics by.

MetricsSummary is the rate of metrics per second.

MetricsSummaryPlugin stores a list of totals for a core instance for a specific plugin.

Pair struct.

Pipeline model.

PipelineCheck type for pipeline level checks.

PipelineChecks paginated list.

PipelineChecksParams request payload for querying the core_instance checks.

PipelineClusterObjectsParams request payload to filter cluster objects belonging to a pipeline.

PipelineConfig model.

PipelineConfigHistory paginated list.

PipelineConfigHistoryParams request payload for querying the pipeline config history.

PipelineEvent model.

PipelineFile model.

PipelineFiles paginated list.

PipelineFilesParams request payload for querying the pipeline files.

PipelineMetadataParams request payload for listing metadata from keys.

PipelineObjectsParams represents the options for including different types of pipeline objects in the response.

PipelineParams request payload for querying a single pipeline.

PipelinePort model.

PipelinePorts paginated list.

PipelinePortsParams request payload for querying the pipeline ports.

Pipelines paginated list.

PipelineSecret model.

PipelineSecrets paginated list.

PipelineSecretsParams request payload for querying the pipeline secrets.

PipelinesMetricsParams request payload for bulk querying pipeline metrics for a given aggregator.

PipelinesParams represents the request payload for querying pipelines.

PipelineStatus model.

PipelineStatusHistory paginated list.

PipelineStatusHistoryParams request payload for querying the pipeline status history.

PreviewProcessingRule request payload to run and preview the input/output of a processing rule.

ProcessingRule defines a set of actions that eventually will get translated into a single fluent-bif filter.

ProcessingRules paginated list.

ProcessingRulesParams request payload for querying processing rules.

Project model.

Projects paginated list.

ProjectsParams request payload for querying projects.

RegisterAgent request payload for registering a new agent.

RegisteredAgent response payload after registering an agent successfully.

ResourceProfile model.

ResourceProfiles paginated list.

ResourceProfilesParams request payload for querying resource profiles.

RuleAction within a processing rule.

TerminatedTraceSession response payload after terminating the active trace session successfully.

Token model.

Tokens paginated list.

TokensParams request payload for querying tokens.

TraceRecord model.

TraceRecords paginated list.

TraceRecordsParams request payload for querying trace records.

TraceSession model.

TraceSessions paginated list.

TraceSessionsParams request payload for querying trace sessions.

UpdateAgent request payload for updating an agent.

UpdateClusterObject request payload for updating a core_instance cluster object.

UpdateConfigSection request payload for updating a fluent-bit config section on a project.

UpdateCoreInstance request payload for updating a core instance.

UpdateCoreInstanceCheck request payload for updating a core_instance check.

UpdatedPipeline response payload after updating a pipeline successfully.

UpdateFleetFile request payload for updating a fleet file.

UpdateIngestCheck request payload for updating a core_instance ingestion check.

UpdateMember request body.

UpdatePipeline request payload for updating a pipeline.

UpdatePipelineCheck request payload for updating a core_instance check.

UpdatePipelineClusterObjects update cluster objects associated to a pipeline.

UpdatePipelineFile request payload for updating a pipeline file.

UpdatePipelineMetadata request payload to store a key on the metadata field with the given value (json serializable).

UpdatePipelinePort request payload for updating a pipeline port.

UpdatePipelineSecret request payload for updating a pipeline secret.

UpdateProcessingRule request payload.

UpdateProject request payload for updating a project.

UpdateResourceProfile request payload for updating a resource profile.

UpdateToken request payload for updating a token.

UpdateTraceSession request payload for updating a trace session.

User model.

AgentArch is set to the architecture an agent is running on.

AgentEdition declares the fluent agent edition (community/enterprise).

AgentOS is set to the operating system the agent is running on.

AgentType declares the fluent agent type (fluentbit/fluentd).

CheckStatus possible status of a check.

ConfigSectionKind enum with known fluent-bit section types.

CreateCoreInstanceCheck request payload for creating a core_instance check.

CreatePipelineCheck request payload for creating a core_instance check.

Duration is a time.Duration wrapper that adds support for encoding/json.

FluentBitLogAttrs wrapper.

FluentBitPluginKind enum with known fluent-bit plugin types.

FluentBitTime wrapper.

LogSelectorKind enum.

LogSelectorOpKind enum of the supported operations a selector.

MembershipRole type of membership role (creator/admin).

Pairs list.

PipelineMetadata is the default metadata format for a pipeline.

PipelinePortProtocol valid protocol types defined for a pipeline.

PipelineStatusKind enum.

ProcessingRuleLanguage enum of scripting languages a processing rule supports.

RuleActionKind enum of the different action kinds a processing rule can have.

TraceRecordKind enum.