package
0.21.0
Repository: https://github.com/calyptia/api.git
Documentation: pkg.go.dev

# Functions

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.

# Constants

AgentEditionCommunity fluent community edition.
AgentEditionEnterprise fluent enterprise edition.
AgentTypeFluentBit fluentbit agent type.
AgentTypeFluentd fluentd agent type.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
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".
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DefaultResourceProfileName is the default resource profile used when creating pipelines.
No description provided by the author
No description provided by the author
No description provided by the author
IngestCheckDefaultTimeout default timeout for an ingest check.
LogSelectorKindKey matches a log using some of its keys.
LogSelectorOpKindEqual matches a log key/value equally.
MembershipRoleAdmin admin membership role.
MembershipRoleCreator creator membership role.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
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.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

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.
No description provided by the author
No description provided by the author

# Structs

AcceptInvitation request payload for accepting a project invitation.
Agent model.
AgentConfig model.
AgentConfigHistory paginated list.
AgentConfigHistoryParams request payload for querying the agent config history.
AgentMeasurement stores per plugin and total agent level metrics.
AgentMetrics response payload for agent level metrics.
Agents paginated list.
AgentsParams request payload for querying agents.
AggregatorMeasurement stores a list of metrics and totals for an aggregator.
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.
ConfigValidity details.
ConfigValidityV2 details.
ConfigValidityV2Property property details.
ConfigValidityV2Runtime runtime details.
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.
CoreInstanceMetricsV1 stores a set of AggregatorMeasurement metrics for an aggregator.
CoreInstancePingResponse response from ancore 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.
CreatedAgentMetrics response model for created agent metrics.
CreatedClusterObject response payload after creating a core_instance cluster object.
CreatedConfigSection response payload after creating a fluent-bit config section successfully.
CreatedCoreInstance response payload after creating a core instance successfully.
CreatedCoreInstanceCheck response payload after creating an aggregator successfully.
No description provided by the author
CreatedFluentBitPluginConfig response payload after creating a fluent-bit plugin config successfully.
CreatedIngestCheck response payload after creating a core ingestion check successfully.
CreatedPipeline response payload after creating a pipeline successfully.
CreatedPipelineCheck response payload after creating an aggregator successfully.
CreatedPipelineFile response payload after creating a pipeline file successfully.
CreatedPipelinePort response payload after creating a pipeline port successfully.
CreatedPipelineSecret response payload after creating a pipeline secret successfully.
CreatedProcessingRule response payload.
CreatedProject response payload after creating a project successfully.
CreatedResourceProfile response payload after creating a resource profile successfully.
CreatedTraceRecord response payload after creating an session record successfully.
CreatedTraceSession response payload after creating a trace session successfully.
No description provided by the author
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.
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 request payload for creating a new trace record.
CreateTraceSession request payload for creating a new trace session.
No description provided by the author
No description provided by the author
No description provided by the author
Error returned by the API.
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.
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.
MetricFields stores a tuple of time, value per metric.
No description provided by the author
Metrics stores a dict of metric type and its fields.
MetricsFilter stores totals for a core instance filter.
No description provided by the author
MetricsInput stores totals for a core instance input.
No description provided by the author
MetricsOutput stores totals for a core instance output.
No description provided by the author
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 stores a list of totals for a core instance.
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.
PipelineMetric response payload for pipeline level metric.
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 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.
ProjectMeasurement struct to store project metrics, used for project level metrics.
ProjectMetrics response payload for project level metrics.
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.
UpdatedConfigSection response payload after updating a fluent-bit config section successfully.
UpdatedPipeline response payload after updating a pipeline successfully.
UpdatedProcessingRule response payload.
UpdatedTraceSession response payload after updating a trace session successfully.
No description provided by the author
UpdateIngestCheck request payload for updating a core_instance ingestion check.
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.
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.
ValidatedConfig response body after validating an agent config successfully.
ValidatedConfigV2 response body after validating an agent config successfully against the v2 endpoint.
ValidatingConfig request body for validating a config.
ValidatingConfigEntry defines a single config to the validated.

# Type aliases

AgentEdition declares the fluent agent edition (community/enterprise).
AgentType declares the fluent agent type (fluentbit/fluentd).
CheckStatus possible status of a check.
No description provided by the author
No description provided by the author
ConfigSectionKind enum with known fluent-bit section types.
No description provided by the author
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.
MeasurementTotal stores totals per measurement.
MembershipRole type of membership role (creator/admin).
MetricsPluginTotal stores totals per plugin metrics.
Pairs list.
No description provided by the author
No description provided by the author
PipelinePortProtocol valid protocol types defined for a pipeline.
PipelinesMetrics response payload for aggregator level pipeline metrics.
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.