cxsdk

package module
v0.0.0-...-2f63041 Latest Latest
Warning

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

Go to latest
Published: Aug 22, 2024 License: Apache-2.0 Imports: 39 Imported by: 0

README

Coralogix Management SDK for Go

The Golang SDK for Coralogix uses (mostly) GRPC for interacting with the SaaS platform. Use make (install if required) to build and test.

Important Makefile Targets

  • make build - builds the binary in the default architecture
  • make proto-clean - clean the Go files created from protobuf
  • make proto-compile - compile the Go files from protobuf
  • make test - run examples/tests

Troubleshooting

Here are some tips for getting everything to work:

panic: proto: extension number 5000 is already registered on message google.protobuf.MethodOptions
	previously from: "github.com/coralogix/coralogix-management-sdk/go/internal/coralogixapis/apm/common/v2"
	currently from:  "github.com/coralogix/coralogix-management-sdk/go/internal/coralogixapis/logs2metrics/v2"
See https://protobuf.dev/reference/go/faq#namespace-conflict

protoc treats conflicting extensions as an error unless this flag is specified (then it's a warning):

-ldflags "-X google.golang.org/protobuf/reflect/protoregistry.conflictPolicy=warn"

Documentation

Overview

Copyright 2024 Coralogix Ltd.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2024 Coralogix Ltd.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2024 Coralogix Ltd.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2024 Coralogix Ltd.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

Constants

View Source
const (
	// SourceTypeSourceTypeUnspecified is an unspecified source type.
	SourceTypeSourceTypeUnspecified = actions.SourceType_SOURCE_TYPE_UNSPECIFIED

	// SourceTypeSourceTypeLog is a webhook source type.
	SourceTypeSourceTypeLog = actions.SourceType_SOURCE_TYPE_LOG

	// SourceTypeSourceTypeDataMap is a data map source type.
	SourceTypeSourceTypeDataMap = actions.SourceType_SOURCE_TYPE_DATA_MAP
)
View Source
const (
	// ScheduleOperationScheduleOperationActivate is a ScheduleOperation that activates an alert scheduler.
	ScheduleOperationScheduleOperationActivate = alertsSchedulers.ScheduleOperation_SCHEDULE_OPERATION_ACTIVATE

	// ScheduleOperationScheduleOperationUnspecified is an unspecified ScheduleOperation.
	ScheduleOperationScheduleOperationUnspecified = alertsSchedulers.ScheduleOperation_SCHEDULE_OPERATION_UNSPECIFIED

	// ScheduleOperationScheduleOperationMute is a ScheduleOperation that mutes an alert scheduler.
	ScheduleOperationScheduleOperationMute = alertsSchedulers.ScheduleOperation_SCHEDULE_OPERATION_MUTE
)
View Source
const (
	// GrpcUS1 is the URL for the us1 region.
	GrpcUS1 = "ng-api-grpc.coralogix.com:443"

	// GrpcUS2 is the URL for the us2 region.
	GrpcUS2 = "ng-api-grpc.cx498.coralogix.com:443"

	// GrpcEU1 is the URL for the eu1 region.
	GrpcEU1 = "ng-api-grpc.coralogix.com:443"

	// GrpcEU2 is the URL for the eu2 region.
	GrpcEU2 = "ng-api-grpc.eu2.coralogix.com:443"

	// GrpcAP1 is the URL for the ap1 region.
	GrpcAP1 = "ng-api-grpc.app.coralogix.in:443"

	// GrpcAP2 is the URL for the ap2 region.
	GrpcAP2 = "ng-api-grpc.coralogixsg.com:443"
)
View Source
const (
	// RestUS1 is the URL for the us1 region.
	RestUS1 = "https://ng-api-http.coralogix.com"

	// RestUS2 is the URL for the us2 region.
	RestUS2 = "https://ng-api-http.cx498.coralogix.com"

	// RestEU1 is the URL for the eu1 region.
	RestEU1 = "https://ng-api-http.coralogix.com"

	// RestEU2 is the URL for the eu2 region.
	RestEU2 = "https://ng-api-http.eu2.coralogix.com"

	// RestAP1 is the URL for the ap1 region.
	RestAP1 = "https://ng-api-http.app.coralogix.in"

	// RestAP2 is the URL for the ap2 region.
	RestAP2 = "https://ng-api-http.coralogixsg.com"
)
View Source
const (
	// EntityTypeUnspecified is an unspecified entity type
	EntityTypeUnspecified = scopes.EntityType_UNSPECIFIED

	// EntityTypeLogs is a logs entity type
	EntityTypeLogs = scopes.EntityType_LOGS

	// EntityTypeSpans is a metrics entity type
	EntityTypeSpans = scopes.EntityType_SPANS
)
View Source
const (
	// WebhookTypeUnknown is an unknown webhook type.
	WebhookTypeUnknown = webhooks.WebhookType_UNKNOWN
	// WebhookTypeGeneric is a generic webhook type.
	WebhookTypeGeneric = webhooks.WebhookType_GENERIC
	// WebhookTypeSlack is a Slack webhook type.
	WebhookTypeSlack = webhooks.WebhookType_SLACK
	// WebhookTypePagerduty is a PagerDuty webhook type.
	WebhookTypePagerduty = webhooks.WebhookType_PAGERDUTY
	// WebhookTypeSendLog is a SendLog webhook type.
	WebhookTypeSendLog = webhooks.WebhookType_SEND_LOG
	// WebhookTypeEmailGroup is an EmailGroup webhook type.
	WebhookTypeEmailGroup = webhooks.WebhookType_EMAIL_GROUP
	// WebhookTypeMicrosoftTeams is a MicrosoftTeams webhook type.
	WebhookTypeMicrosoftTeams = webhooks.WebhookType_MICROSOFT_TEAMS
	// WebhookTypeJira is a Jira webhook type.
	WebhookTypeJira = webhooks.WebhookType_JIRA
	// WebhookTypeOpsgenie is an Opsgenie webhook type.
	WebhookTypeOpsgenie = webhooks.WebhookType_OPSGENIE
	// WebhookTypeDemisto is a Demisto webhook type.
	WebhookTypeDemisto = webhooks.WebhookType_DEMISTO
	// WebhookTypeAwsEventBridge is an AWS EventBridge webhook type.
	WebhookTypeAwsEventBridge = webhooks.WebhookType_AWS_EVENT_BRIDGE
	// WebhookTypeIbmEventNotifications is an IBM Event Notifications webhook type.
	WebhookTypeIbmEventNotifications = webhooks.WebhookType_IBM_EVENT_NOTIFICATIONS
)
View Source
const (
	// GenericWebhookConfigUnknown is an unknown config
	GenericWebhookConfigUnknown = webhooks.GenericWebhookConfig_UNKNOWN
	// GenericWebhookConfigGet is a GET request
	GenericWebhookConfigGet = webhooks.GenericWebhookConfig_GET
	// GenericWebhookConfigPost is a POST request
	GenericWebhookConfigPost = webhooks.GenericWebhookConfig_POST
	// GenericWebhookConfigPut is a PUT request
	GenericWebhookConfigPut = webhooks.GenericWebhookConfig_PUT
)
View Source
const (
	// SlackConfigEmpty is an empty attachment
	SlackConfigEmpty = webhooks.SlackConfig_EMPTY
	// SlackConfigMetricSnapshot for metrics
	SlackConfigMetricSnapshot = webhooks.SlackConfig_METRIC_SNAPSHOT
	// SlackConfigLogs for logs
	SlackConfigLogs = webhooks.SlackConfig_LOGS
	// SlackConfigUnknown unknown digest
	SlackConfigUnknown = webhooks.SlackConfig_UNKNOWN
	// SlackConfigErrorAndCriticalLogs for error and critical logs
	SlackConfigErrorAndCriticalLogs = webhooks.SlackConfig_ERROR_AND_CRITICAL_LOGS
	// SlackConfigFlowAnomalies for flow anomalies
	SlackConfigFlowAnomalies = webhooks.SlackConfig_FLOW_ANOMALIES
	// SlackConfigSpikeAnomalies for spike anomalies
	SlackConfigSpikeAnomalies = webhooks.SlackConfig_SPIKE_ANOMALIES
	// SlackConfigDataUsage for data usage
	SlackConfigDataUsage = webhooks.SlackConfig_DATA_USAGE
)

AlertDefPriorityP1 is the alert priority P1.

AlertDefPriorityP2 is the alert priority P2.

AlertDefPriorityP3 is the alert priority P3.

AlertDefPriorityP4 is the alert priority P4.

AlertDefPriorityP5OrUnspecified is the alert priority P5 or unspecified.

AlertDefTypeFlow is the alert type "flow".

View Source
const AlertDefTypeLogsImmediateOrUnspecified = alerts.AlertDefType_ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED

AlertDefTypeLogsImmediateOrUnspecified is the alert type "logs immediate or unspecified".

AlertDefTypeLogsLessThan is the alert type "logs less than".

AlertDefTypeLogsMoreThan is the alert type "logs more than".

AlertDefTypeLogsMoreThanUsual is the alert type "logs more than usual".

AlertDefTypeLogsNewValue is the alert type "logs new value".

AlertDefTypeLogsRatioLessThan is the alert type "logs ratio less than".

AlertDefTypeLogsRatioMoreThan is the alert type "logs ratio more than".

View Source
const AlertDefTypeLogsTimeRelativeLessThan = alerts.AlertDefType_ALERT_DEF_TYPE_LOGS_TIME_RELATIVE_LESS_THAN

AlertDefTypeLogsTimeRelativeLessThan is the alert type "logs time relative less than".

View Source
const AlertDefTypeLogsTimeRelativeMoreThan = alerts.AlertDefType_ALERT_DEF_TYPE_LOGS_TIME_RELATIVE_MORE_THAN

AlertDefTypeLogsTimeRelativeMoreThan is the alert type "logs time relative more than".

AlertDefTypeLogsUniqueCount is the alert type "logs unique count".

AlertDefTypeMetricLessThan is the alert type "metric less than".

AlertDefTypeMetricLessThanOrEquals is the alert type "metric less than or equals".

AlertDefTypeMetricLessThanUsual is the alert type "metric less than usual".

AlertDefTypeMetricMoreThan is the alert type "metric less than".

AlertDefTypeMetricMoreThanOrEquals is the alert type "metric more than or equals".

AlertDefTypeMetricMoreThanUsual is the alert type "metric more than usual".

AlertDefTypeTracingImmediate is the alert type "tracing immediate".

AlertDefTypeTracingMoreThan is the alert type "tracing more than".

View Source
const EnvCoralogixTeamLevelAPIKey = "CORALOGIX_TEAM_API_KEY"

EnvCoralogixTeamLevelAPIKey is the name of the environment variable that contains the Coralogix Team API key.

View Source
const EnvCoralogixUserLevelAPIKey = "CORALOGIX_USER_API_KEY"

EnvCoralogixUserLevelAPIKey is the name of the environment variable that contains the Coralogix User API key.

View Source
const EnvCoralogxRegion = "CORALOGIX_REGION"

EnvCoralogxRegion is the name of the environment variable that contains the Coralogix region.

Variables

This section is empty.

Functions

func CoralogixGrpcEndpointFromRegion

func CoralogixGrpcEndpointFromRegion(regionIdentifier string) string

CoralogixGrpcEndpointFromRegion reads the Coralogix region from environment variables.

func CoralogixRegionFromEnv

func CoralogixRegionFromEnv() (string, error)

CoralogixRegionFromEnv reads the Coralogix region from environment variables.

func CoralogixRestEndpointFromRegion

func CoralogixRestEndpointFromRegion(regionIdentifier string) string

CoralogixRestEndpointFromRegion reads the Coralogix REST endpoint from environment variables.

func CoralogixTeamsLevelAPIKeyFromEnv

func CoralogixTeamsLevelAPIKeyFromEnv() (string, error)

CoralogixTeamsLevelAPIKeyFromEnv reads the Coralogix Team API key from environment variables.

func CoralogixUserLevelAPIKeyFromEnv

func CoralogixUserLevelAPIKeyFromEnv() (string, error)

CoralogixUserLevelAPIKeyFromEnv reads the Coralogix User API key from environment variables.

Types

type APIKeyPermissions

type APIKeyPermissions = apikeys.CreateApiKeyRequest_KeyPermissions

APIKeyPermissions is a set of permissions for an API key.

type Action

type Action = actions.Action

Action is an action.

type ActionsClient

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

ActionsClient is a client for the Coralogix Actions API.

func NewActionsClient

func NewActionsClient(c *CallPropertiesCreator) *ActionsClient

NewActionsClient Creates a new actions client.

func (ActionsClient) Create

Create creates a new action.

func (ActionsClient) Delete

Delete deletes an action.

func (ActionsClient) Get

Get gets an action.

func (ActionsClient) Order

Order sets the order of actions.

func (ActionsClient) Replace

Replace replaces an action.

type AlertDefAdvancedNotificationGroup

type AlertDefAdvancedNotificationGroup = alerts.AlertDefNotificationGroup_Advanced

AlertDefAdvancedNotificationGroup represents an advanced notification group.

type AlertDefAdvancedTargets

type AlertDefAdvancedTargets = alerts.AlertDefAdvancedTargets

AlertDefAdvancedTargets represents a set of advanced targets.

type AlertDefIntegrationType

type AlertDefIntegrationType = alerts.IntegrationType

AlertDefIntegrationType represents an integration type.

type AlertDefIntegrationTypeIntegrationID

type AlertDefIntegrationTypeIntegrationID = alerts.IntegrationType_IntegrationId

AlertDefIntegrationTypeIntegrationID represents an integration of type integration ID.

type AlertDefIntegrationTypeRecipients

type AlertDefIntegrationTypeRecipients = alerts.IntegrationType_Recipients

AlertDefIntegrationTypeRecipients represents an integration of type recipients.

type AlertDefNotificationGroup

type AlertDefNotificationGroup = alerts.AlertDefNotificationGroup

AlertDefNotificationGroup represents a notification group.

type AlertDefProperties

type AlertDefProperties = alerts.AlertDefProperties

AlertDefProperties is the properties of an alert.

type AlertDefRecipients

type AlertDefRecipients = alerts.Recipients

AlertDefRecipients represents the recipients of a notification.

type AlertDefScheduleActiveOn

type AlertDefScheduleActiveOn = alerts.AlertDefProperties_ActiveOn

AlertDefScheduleActiveOn represents the active on schedule of an alert.

type AlertDefSimpleNotificationGroup

type AlertDefSimpleNotificationGroup = alerts.AlertDefNotificationGroup_Simple

AlertDefSimpleNotificationGroup represents a simple notification group.

type AlertDefSimpleTarget

type AlertDefSimpleTarget = alerts.AlertDefTargetSimple

AlertDefSimpleTarget represents a simple target.

type AlertSchedulerFilter

type AlertSchedulerFilter = alertsSchedulers.Filter

AlertSchedulerFilter is a filter for an alert scheduler rule.

type AlertSchedulerFilterUniqueIDs

type AlertSchedulerFilterUniqueIDs = alertsSchedulers.Filter_AlertUniqueIds

AlertSchedulerFilterUniqueIDs is a filter for an alert scheduler rule that contains unique IDs.

type AlertSchedulerRule

type AlertSchedulerRule = alertsSchedulers.AlertSchedulerRule

AlertSchedulerRule is an alert scheduler rule.

type AlertUniqueIDs

type AlertUniqueIDs = alertsSchedulers.AlertUniqueIds

AlertUniqueIDs is a list of alert unique IDs.

type AlertsClient

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

AlertsClient is a client for the Coralogix Alerts API.

func NewAlertsClient

func NewAlertsClient(c *CallPropertiesCreator) *AlertsClient

NewAlertsClient creates a new alerts client.

func (AlertsClient) Create

Create creates an alert.

func (AlertsClient) Delete

Delete deletes an alert.

func (AlertsClient) Get

Get gets an alert.

func (AlertsClient) List

List lists the alerts.

func (AlertsClient) Replace

Replace replaces an alert.

func (AlertsClient) Set

Set sets the active status of an alert.

type AlertsSchedulersClient

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

AlertsSchedulersClient is a client for the Coralogix Alerts API.

func NewAlertsSchedulersClient

func NewAlertsSchedulersClient(c *CallPropertiesCreator) *AlertsSchedulersClient

NewAlertsSchedulersClient creates a new alerts scheduler client.

func (AlertsSchedulersClient) Create

Create creates a new alert scheduler.

func (AlertsSchedulersClient) CreateBulk

CreateBulk creates multiple alert schedulers in bulk.

func (AlertsSchedulersClient) Delete

Delete deletes an alert scheduler.

func (AlertsSchedulersClient) Get

Get gets an alert scheduler.

func (AlertsSchedulersClient) GetBulk

GetBulk gets multiple alert schedulers in bulk.

func (AlertsSchedulersClient) Update

Update updates an alert scheduler.

func (AlertsSchedulersClient) UpdateBulk

UpdateBulk updates multiple alert schedulers in bulk.

type ApikeysClient

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

ApikeysClient is a client for the Coralogix API keys API.

func NewAPIKeysClient

func NewAPIKeysClient(c *CallPropertiesCreator) *ApikeysClient

NewAPIKeysClient creates a new API keys client.

func (ApikeysClient) Create

Create creates a new API key.

func (ApikeysClient) Delete

Delete deletes an API key.

func (ApikeysClient) Get

Get gets an API key.

func (ApikeysClient) Update

Update updates an API key.

type ArchiveLogsClient

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

ArchiveLogsClient is a client for the Coralogix Archive Logs API.

func NewArchiveLogsClient

func NewArchiveLogsClient(c *CallPropertiesCreator) *ArchiveLogsClient

NewArchiveLogsClient creates a new archive logs client.

func (ArchiveLogsClient) Get

Get gets the archive logs target.

func (ArchiveLogsClient) Update

Update updates the archive logs target.

func (ArchiveLogsClient) ValidateTarget

ValidateTarget validates the archive logs target.

type ArchiveMetricsClient

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

ArchiveMetricsClient is a client for the Coralogix Archive Metrics API.

func NewArchiveMetricsClient

func NewArchiveMetricsClient(c *CallPropertiesCreator) *ArchiveMetricsClient

NewArchiveMetricsClient creates a new archive metrics client.

func (ArchiveMetricsClient) ConfigureTenant

ConfigureTenant configures the archive metrics bucket.

func (ArchiveMetricsClient) Disable

Disable disables the metrics archive.

func (ArchiveMetricsClient) Enable

Enable enables the metrics archive.

func (ArchiveMetricsClient) Get

Get gets the archive metrics configuration.

func (ArchiveMetricsClient) Update

Update updates the archive metrics configuration.

func (ArchiveMetricsClient) ValidateTarget

ValidateTarget validates the archive metrics bucket.

type ArchiveRetentionsClient

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

ArchiveRetentionsClient is a client for the Coralogix Archive Retentions API.

func NewArchiveRetentionsClient

func NewArchiveRetentionsClient(c *CallPropertiesCreator) *ArchiveRetentionsClient

NewArchiveRetentionsClient Creates a new archive retentions client.

func (ArchiveRetentionsClient) Activate

Activate activates the archive retentions.

func (ArchiveRetentionsClient) Get

Get gets the archive retentions.

func (ArchiveRetentionsClient) GetEnabled

GetEnabled returns a boolean that signals whether archive retentions are enabled.

func (ArchiveRetentionsClient) Update

Update updates the archive retentions.

type ArchiveS3Config

type ArchiveS3Config = archiveMetrics.S3Config

ArchiveS3Config is an S3 configuration for the archive.

type AuthContext

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

AuthContext is a struct that holds the API keys for the Coralogix SDK.

func AuthContextFromEnv

func AuthContextFromEnv() (AuthContext, error)

AuthContextFromEnv reads the Coralogix API keys from environment variables.

func NewAuthContext

func NewAuthContext(teamLevelAPIKey, userLevelAPIKey string) AuthContext

NewAuthContext creates a new AuthContext.

type AwsEventBridge

AwsEventBridge is a Webhook Type

type AwsEventBridgeConfig

type AwsEventBridgeConfig = webhooks.AwsEventBridgeConfig

AwsEventBridgeConfig configures the service

type CallProperties

type CallProperties struct {
	Ctx         context.Context
	Connection  *grpc.ClientConn
	CallOptions []grpc.CallOption
}

CallProperties is a struct that holds the context, connection, and call options for a gRPC call.

type CallPropertiesCreator

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

CallPropertiesCreator is a struct that creates CallProperties objects.

func NewCallPropertiesCreator

func NewCallPropertiesCreator(region string, authContext AuthContext) *CallPropertiesCreator

NewCallPropertiesCreator creates a new CallPropertiesCreator object.

func (CallPropertiesCreator) GetTeamsLevelCallProperties

func (c CallPropertiesCreator) GetTeamsLevelCallProperties(ctx context.Context) (*CallProperties, error)

GetTeamsLevelCallProperties returns a new CallProperties object built from a team-level API key. It essentially prepares the context, connection, and call options for a gRPC call.

func (CallPropertiesCreator) GetUserLevelCallProperties

func (c CallPropertiesCreator) GetUserLevelCallProperties(ctx context.Context) (*CallProperties, error)

GetUserLevelCallProperties returns a new CallProperties object built from a user-level API key. It essentially prepares the context, connection, and call options for a gRPC call.

type ClientSet

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

ClientSet is a set of clients for the Coralogix SDK.

func NewClientSet

func NewClientSet(targetURL, teamsLevelAPIKey string, userLevelAPIKey string) *ClientSet

NewClientSet Creates a new ClientSet.

func (*ClientSet) APIKeys

func (c *ClientSet) APIKeys() *ApikeysClient

APIKeys gets an SLOsClient from the ClientSet.

func (*ClientSet) Actions

func (c *ClientSet) Actions() *ActionsClient

Actions gets an ActionsClient from the ClientSet.

func (*ClientSet) AlertSchedulers

func (c *ClientSet) AlertSchedulers() *AlertsSchedulersClient

AlertSchedulers Gets an AlertsSchedulersClient from the ClientSet.

func (*ClientSet) Alerts

func (c *ClientSet) Alerts() *AlertsClient

Alerts gets an AlertsClient from the ClientSet.

func (*ClientSet) ArchiveLogs

func (c *ClientSet) ArchiveLogs() *ArchiveLogsClient

ArchiveLogs gets an ArchiveLogsClient from the ClientSet.

func (*ClientSet) ArchiveMetrics

func (c *ClientSet) ArchiveMetrics() *ArchiveMetricsClient

ArchiveMetrics gets an ArchiveMetricsClient from the ClientSet.

func (*ClientSet) ArchiveRetentions

func (c *ClientSet) ArchiveRetentions() *ArchiveRetentionsClient

ArchiveRetentions gets an ArchiveRetentionsClient from the ClientSet.

func (*ClientSet) DataSet

func (c *ClientSet) DataSet() *DataSetClient

DataSet gets a DataSetClient from the ClientSet.

func (*ClientSet) Enrichments

func (c *ClientSet) Enrichments() *EnrichmentsClient

Enrichments gets an EnrichmentsClient from the ClientSet.

func (*ClientSet) Events2Metrics

func (c *ClientSet) Events2Metrics() *Events2MetricsClient

Events2Metrics gets an Events2MetricsClient from the ClientSet.

func (*ClientSet) Groups

func (c *ClientSet) Groups() *GroupsClient

Groups gets a GroupsClient from the ClientSet.

func (*ClientSet) RuleGroups

func (c *ClientSet) RuleGroups() *RuleGroupsClient

RuleGroups gets a RuleGroupsClient from the ClientSet.

func (*ClientSet) SLOs

func (c *ClientSet) SLOs() *SLOsClient

SLOs gets an SLOsClient from the ClientSet.

func (*ClientSet) Scopes

func (c *ClientSet) Scopes() *ScopesClient

Scopes gets a ScopesClient from the ClientSet.

func (*ClientSet) TCOPolicies

func (c *ClientSet) TCOPolicies() *TCOPoliciesClient

TCOPolicies gets a TCOPoliciesClient from the ClientSet.

func (*ClientSet) Teams

func (c *ClientSet) Teams() *TeamsClient

Teams gets a TeamsClient from the ClientSet.

func (*ClientSet) Users

func (c *ClientSet) Users() *UsersClient

Users gets a UsersClient from the ClientSet.

func (*ClientSet) Webhooks

func (c *ClientSet) Webhooks() *WebhooksClient

Webhooks gets a WebhooksClient from the ClientSet.

type ConfigureTenantRequest

type ConfigureTenantRequest = archiveMetrics.ConfigureTenantRequest

ConfigureTenantRequest is a request to configure the tenant.

type ConfigureTenantRequestS3

type ConfigureTenantRequestS3 = archiveMetrics.ConfigureTenantRequest_S3

ConfigureTenantRequestS3 is a request to configure the tenant with S3.

type CreateAPIKeyRequest

type CreateAPIKeyRequest = apikeys.CreateApiKeyRequest

CreateAPIKeyRequest is a request to create an API key.

type CreateActionRequest

type CreateActionRequest = actions.CreateActionRequest

CreateActionRequest is a request to create an action.

type CreateAlertRequest

type CreateAlertRequest = alerts.CreateAlertDefRequest

CreateAlertRequest is a request to create an alert.

type CreateAlertSchedulerRuleRequest

type CreateAlertSchedulerRuleRequest = alertsSchedulers.CreateAlertSchedulerRuleRequest

CreateAlertSchedulerRuleRequest is a request to create an alert scheduler rule.

type CreateDashboardFolderRequest

type CreateDashboardFolderRequest = dashboards.CreateDashboardFolderRequest

CreateDashboardFolderRequest is a request to create a dashboards folder.

type CreateDashboardRequest

type CreateDashboardRequest = dashboards.CreateDashboardRequest

CreateDashboardRequest is a request to create a dashboard.

type CreateDataSetRequest

type CreateDataSetRequest = enrichment.CreateCustomEnrichmentRequest

CreateDataSetRequest is a request to create a data set.

type CreateOutgoingWebhookRequest

type CreateOutgoingWebhookRequest = webhooks.CreateOutgoingWebhookRequest

CreateOutgoingWebhookRequest is a request to create a new webhook.

type CreateScopeRequest

type CreateScopeRequest = scopes.CreateScopeRequest

CreateScopeRequest is a request to create a new scope

type CreateServiceSloRequest

type CreateServiceSloRequest = slos.CreateServiceSloRequest

CreateServiceSloRequest is a request to create an SLO.

type CreateTeamInOrgRequest

type CreateTeamInOrgRequest = teams.CreateTeamInOrgRequest

CreateTeamInOrgRequest is a request to create a team.

type Dashboard

type Dashboard = dashboards.Dashboard

Dashboard is a dashboard.

type DashboardFolder

type DashboardFolder = dashboards.DashboardFolder

DashboardFolder is a dashboard folder.

type DashboardFolderPath

type DashboardFolderPath = dashboards.Dashboard_FolderPath

DashboardFolderPath is a dashboard folder path.

type DashboardsClient

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

DashboardsClient is a client for the Coralogix Dashboards API.

func NewDashboardsClient

func NewDashboardsClient(c *CallPropertiesCreator) *DashboardsClient

NewDashboardsClient creates a new DashboardsClient.

func (DashboardsClient) AssignToFolder

AssignToFolder assigns a dashboard to a folder.

func (DashboardsClient) Create

Create Creates a new dashboard.

func (DashboardsClient) Delete

Delete deletes a dashboard.

func (DashboardsClient) Get

Get gets a dashboard.

func (DashboardsClient) List

List lists all dashboards.

func (DashboardsClient) Pin

Pin pins a dashboard.

func (DashboardsClient) Replace

Replace replaces a dashboard.

func (DashboardsClient) Unpin

Unpin unpins a dashboard.

type DashboardsFoldersClient

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

DashboardsFoldersClient is a client for the Coralogix Dashboards Folders API.

func NewDashboardsFoldersClient

func NewDashboardsFoldersClient(c *CallPropertiesCreator) *DashboardsFoldersClient

NewDashboardsFoldersClient Creates a new DashboardsFoldersClient.

func (DashboardsFoldersClient) Create

Create creates a new dashboard folder.

func (DashboardsFoldersClient) Delete

Delete deletes a dashboard folder.

func (DashboardsFoldersClient) Get

Get dashboard folder details.

func (DashboardsFoldersClient) List

List gets all dashboard folders.

func (DashboardsFoldersClient) Replace

Replace updates a dashboard folder.

type DataSetClient

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

DataSetClient is a client for the Coralogix Data Sets API.

func NewDataSetClient

func NewDataSetClient(c *CallPropertiesCreator) *DataSetClient

NewDataSetClient creates a new data set client.

func (DataSetClient) Create

Create creates a new data set.

func (DataSetClient) Delete

Delete deletes a data set.

func (DataSetClient) Get

Get gets a data set.

func (DataSetClient) List

List retrieves all data sets.

func (DataSetClient) Update

Update updates a data set.

type DataprimeClient

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

DataprimeClient is a client for the Coralogix Dataprime API.

func NewDataprimeClient

func NewDataprimeClient(c *CallPropertiesCreator) *DataprimeClient

NewDataprimeClient creates a new dataprime client.

func (DataprimeClient) Query

Query runs a query.

type DataprimeQueryMetadata

type DataprimeQueryMetadata = dataprime.Metadata

DataprimeQueryMetadata is the metadata for the query

type DeleteAPIKeyRequest

type DeleteAPIKeyRequest = apikeys.DeleteApiKeyRequest

DeleteAPIKeyRequest is a request to delete an API key.

type DeleteActionRequest

type DeleteActionRequest = actions.DeleteActionRequest

DeleteActionRequest is a request to delete an action.

type DeleteAlertSchedulerRuleRequest

type DeleteAlertSchedulerRuleRequest = alertsSchedulers.DeleteAlertSchedulerRuleRequest

DeleteAlertSchedulerRuleRequest is a request to delete an alert scheduler rule.

type DeleteDashboardRequest

type DeleteDashboardRequest = dashboards.DeleteDashboardRequest

DeleteDashboardRequest is a request to delete a dashboard.

type DeleteDataSetRequest

type DeleteDataSetRequest = enrichment.DeleteCustomEnrichmentRequest

DeleteDataSetRequest is a request to delete a data set.

type DeleteIntegrationRequest

type DeleteIntegrationRequest = ext.DeleteIntegrationRequest

DeleteIntegrationRequest is a request to delete an integration.

type DeleteOutgoingWebhookRequest

type DeleteOutgoingWebhookRequest = webhooks.DeleteOutgoingWebhookRequest

DeleteOutgoingWebhookRequest is a request to delete a webhook.

type DeleteScopeRequest

type DeleteScopeRequest = scopes.DeleteScopeRequest

DeleteScopeRequest is a request to delete a scope

type DeleteServiceSloRequest

type DeleteServiceSloRequest = slos.DeleteServiceSloRequest

DeleteServiceSloRequest is a request to delete an SLO.

type DeleteTeamRequest

type DeleteTeamRequest = teams.DeleteTeamRequest

DeleteTeamRequest is a request to delete a team.

type Demisto

Demisto is a Webhook Type

type DemistoConfig

type DemistoConfig = webhooks.DemistoConfig

DemistoConfig configures the service

type EmailGroup

EmailGroup is a Webhook Type

type EmailGroupConfig

type EmailGroupConfig = webhooks.EmailGroupConfig

EmailGroupConfig configures the service

type EnrichmentsClient

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

EnrichmentsClient is a client for the Coralogix Enrichments API.

func NewEnrichmentClient

func NewEnrichmentClient(c *CallPropertiesCreator) *EnrichmentsClient

NewEnrichmentClient creates a new enrichments client.

func (EnrichmentsClient) Create

Create creates a new enrichment.

func (EnrichmentsClient) Delete

Delete deletes the specified enrichments.

func (EnrichmentsClient) Get

func (e EnrichmentsClient) Get(ctx context.Context, customEnrichmentID uint32) ([]*enrichment.Enrichment, error)

Get gets all custom enrichments.

func (EnrichmentsClient) GetByType

func (e EnrichmentsClient) GetByType(ctx context.Context, enrichmentType string) ([]*enrichment.Enrichment, error)

GetByType gets all enrichments of a certain type.

func (EnrichmentsClient) GetLimits

GetLimits returns the enrichment limits.

func (EnrichmentsClient) List

List returns all enrichments.

type Events2MetricsClient

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

Events2MetricsClient is a client for the Coralogix Events2Metrics API. Read more at https://coralogix.com/docs/events2metrics/

func NewEvents2MetricsClient

func NewEvents2MetricsClient(c *CallPropertiesCreator) *Events2MetricsClient

NewEvents2MetricsClient creates a new Events2MetricsClient.

func (Events2MetricsClient) Create

Create Creates a new metric.

func (Events2MetricsClient) Delete

Delete deletes a metric.

func (Events2MetricsClient) Get

Get gets a metric.

func (Events2MetricsClient) List

List lists all metrics

func (Events2MetricsClient) ListLabelsCardinality

ListLabelsCardinality lists the cardinality of labels for a given metric.

func (Events2MetricsClient) Replace

Replace replaces a metric.

type File

type File = enrichment.File

File is a file. Can be either FileBinary or FileTextual.

type FileBinary

type FileBinary = enrichment.File_Binary

FileBinary is a binary file.

type FileTextual

type FileTextual = enrichment.File_Textual

FileTextual is a textual file.

type Filter

type Filter = scopes.Filter

Filter is a filter for a scope

type FolderPath

type FolderPath = dashboards.FolderPath

FolderPath is a dashboard folder path.

type GenericIntegrationParameters

type GenericIntegrationParameters = ext.GenericIntegrationParameters

GenericIntegrationParameters are the integration parameters.

type GenericWebhook

GenericWebhook is a Webhook Type

type GenericWebhookConfig

type GenericWebhookConfig = webhooks.GenericWebhookConfig

GenericWebhookConfig is the configuration for a generic webhook.

type GetAPIKeyRequest

type GetAPIKeyRequest = apikeys.GetApiKeyRequest

GetAPIKeyRequest is a request to get an API key.

type GetActionRequest

type GetActionRequest = actions.GetActionRequest

GetActionRequest is a request to get an action.

type GetAlertSchedulerRuleRequest

type GetAlertSchedulerRuleRequest = alertsSchedulers.GetAlertSchedulerRuleRequest

GetAlertSchedulerRuleRequest is a request to get an alert scheduler rule.

type GetDashboardFolderRequest

type GetDashboardFolderRequest = dashboards.GetDashboardFolderRequest

GetDashboardFolderRequest is a request to get a dashboard folders.

type GetDashboardRequest

type GetDashboardRequest = dashboards.GetDashboardRequest

GetDashboardRequest is a request to get a dashboard.

type GetDataSetRequest

type GetDataSetRequest = enrichment.GetCustomEnrichmentRequest

GetDataSetRequest is a request to get a data set.

type GetDeployedIntegrationRequest

type GetDeployedIntegrationRequest = ext.GetDeployedIntegrationRequest

GetDeployedIntegrationRequest is a request to get a deployed integration.

type GetDeployedIntegrationResponse

type GetDeployedIntegrationResponse = ext.GetDeployedIntegrationResponse

GetDeployedIntegrationResponse contains the response to a GetDeployedIntegrationRequest.

type GetIntegrationDefinitionRequest

type GetIntegrationDefinitionRequest = ext.GetIntegrationDefinitionRequest

GetIntegrationDefinitionRequest is a request to get an integration definition.

type GetIntegrationDetailsRequest

type GetIntegrationDetailsRequest = ext.GetIntegrationDetailsRequest

GetIntegrationDetailsRequest is a request to get integration details.

type GetManagedIntegrationStatusRequest

type GetManagedIntegrationStatusRequest = ext.GetManagedIntegrationStatusRequest

GetManagedIntegrationStatusRequest is a request to get the status of a managed integration.

type GetOutgoingWebhookRequest

type GetOutgoingWebhookRequest = webhooks.GetOutgoingWebhookRequest

GetOutgoingWebhookRequest is a request to get a webhook by its ID.

type GetRumApplicationVersionDataRequest

type GetRumApplicationVersionDataRequest = ext.GetRumApplicationVersionDataRequest

GetRumApplicationVersionDataRequest is a request to get RUM application version data.

type GetServiceSloRequest

type GetServiceSloRequest = slos.GetServiceSloRequest

GetServiceSloRequest is a request to get an SLO.

type GetTeamQuotaRequest

type GetTeamQuotaRequest = teams.GetTeamQuotaRequest

GetTeamQuotaRequest is a request to get the quota for a team.

type GetTeamRequest

type GetTeamRequest = teams.GetTeamRequest

GetTeamRequest is a request to get a team.

type GetTeamScopesByIDsRequest

type GetTeamScopesByIDsRequest = scopes.GetTeamScopesByIdsRequest

GetTeamScopesByIDsRequest is a request to get a scope by its ID

type GetTeamScopesRequest

type GetTeamScopesRequest = scopes.GetTeamScopesRequest

GetTeamScopesRequest is a request to list all scopes for the current team

type GetTemplateRequest

type GetTemplateRequest = ext.GetTemplateRequest

GetTemplateRequest is a request to get an integration template.

type GetTenantConfigRequest

type GetTenantConfigRequest = archiveMetrics.GetTenantConfigRequest

GetTenantConfigRequest is a request to get the tenant configuration.

type GroupsClient

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

GroupsClient is a client for the Groups API

func NewGroupsClient

func NewGroupsClient(callPropertiesCreator *CallPropertiesCreator) *GroupsClient

NewGroupsClient creates a new GroupsClient

func (GroupsClient) AddUsers

AddUsers adds users to a group

func (GroupsClient) Create

Create creates a new group

func (GroupsClient) Delete

Delete deletes a group by ID

func (GroupsClient) Get

Get retrieves a group by ID

func (GroupsClient) List

List retrieves all groups in the team

func (GroupsClient) RemoveUsers

RemoveUsers removes users from a group

func (GroupsClient) Update

Update updates a group

type IbmEventNotifications

IbmEventNotifications is a Webhook Type

type IbmEventNotificationsConfig

type IbmEventNotificationsConfig = webhooks.IbmEventNotificationsConfig

IbmEventNotificationsConfig configures the service

type IntegrationDetailsDefault

type IntegrationDetailsDefault = ext.IntegrationDetails_Default

IntegrationDetailsDefault the type for all registered instances

type IntegrationMetadata

type IntegrationMetadata = ext.IntegrationMetadata

IntegrationMetadata is an integration.

type IntegrationMetadataIntegrationParameters

type IntegrationMetadataIntegrationParameters = ext.IntegrationMetadata_IntegrationParameters

IntegrationMetadataIntegrationParameters is integration parameters.

type IntegrationParameter

type IntegrationParameter = ext.Parameter

IntegrationParameter is a parameter for configuring an integration.

type IntegrationParameterAPIKey

type IntegrationParameterAPIKey = ext.Parameter_ApiKey

IntegrationParameterAPIKey is an API key parameter.

type IntegrationParameterBooleanValue

type IntegrationParameterBooleanValue = ext.Parameter_BooleanValue

IntegrationParameterBooleanValue is a boolean value parameter.

type IntegrationParameterNumericValue

type IntegrationParameterNumericValue = ext.Parameter_NumericValue

IntegrationParameterNumericValue is a numeric value parameter.

type IntegrationParameterSensitiveData

type IntegrationParameterSensitiveData = ext.Parameter_SensitiveData

IntegrationParameterSensitiveData is a sensitive data parameter.

type IntegrationParameterStringList

type IntegrationParameterStringList = ext.Parameter_StringList_

IntegrationParameterStringList is a string list parameter.

type IntegrationParameterStringListInner

type IntegrationParameterStringListInner = ext.Parameter_StringList

IntegrationParameterStringListInner is the wrapped string list parameter.

type IntegrationParameterStringValue

type IntegrationParameterStringValue = ext.Parameter_StringValue

IntegrationParameterStringValue is a string value parameter.

type IntegrationTestFail

type IntegrationTestFail = ext.TestIntegrationResult_Failure_

IntegrationTestFail indicates whether a test was a failure

type IntegrationTestSuccess

type IntegrationTestSuccess = ext.TestIntegrationResult_Success_

IntegrationTestSuccess indicates whether a test was a success

type IntegrationsClient

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

IntegrationsClient is a client for the Coralogix Extensions API.

func NewIntegrationsClient

func NewIntegrationsClient(c *CallPropertiesCreator) *IntegrationsClient

NewIntegrationsClient creates a new client.

func (IntegrationsClient) Create

Create creates a new integration.

func (IntegrationsClient) Delete

Delete deletes an integration

func (IntegrationsClient) Get

Get gets a deployed integration

func (IntegrationsClient) GetDefinition

GetDefinition gets an integration definition

func (IntegrationsClient) GetDetails

GetDetails gets all deployed integrations

func (IntegrationsClient) GetIntegrationStatus

GetIntegrationStatus gets the status of a integration

func (IntegrationsClient) GetRumApplicationVersionData

GetRumApplicationVersionData gets RUM application version data

func (IntegrationsClient) GetTemplate

GetTemplate gets an integration template

func (IntegrationsClient) SyncRumData

SyncRumData syncs RUM data

func (IntegrationsClient) Test

Test tests an integration

func (IntegrationsClient) Update

Update updates an integration

type Jira

Jira is a Webhook Type

type JiraConfig

type JiraConfig = webhooks.JiraConfig

JiraConfig configures the service

type ListAlertDefsRequest

type ListAlertDefsRequest = alerts.ListAlertDefsRequest

ListAlertDefsRequest is a request to list alerts.

type ListAllOutgoingWebhooksRequest

type ListAllOutgoingWebhooksRequest = webhooks.ListAllOutgoingWebhooksRequest

ListAllOutgoingWebhooksRequest is a request to list all webhooks.

type ListDashboardFolderRequest

type ListDashboardFolderRequest = dashboards.ListDashboardFoldersRequest

ListDashboardFolderRequest is a request to get a dashboard folders.

type ListOutgoingWebhookTypesRequest

type ListOutgoingWebhookTypesRequest = webhooks.ListOutgoingWebhookTypesRequest

ListOutgoingWebhookTypesRequest is a request to list all webhook types.

type MetaLabel

type MetaLabel = metaLabels.MetaLabel

MetaLabel is a piece of metadata.

type MicrosoftTeams

MicrosoftTeams is a Webhook Type

type MicrosoftTeamsConfig

type MicrosoftTeamsConfig = webhooks.MicrosoftTeamsConfig

MicrosoftTeamsConfig configures the service

type MoveQuotaRequest

type MoveQuotaRequest = teams.MoveQuotaRequest

MoveQuotaRequest is a request to move the quota from one team to another.

type OneTime

type OneTime = alertsSchedulers.OneTime

OneTime is a one-time schedule.

type Opsgenie

Opsgenie is a Webhook Type

type OpsgenieConfig

type OpsgenieConfig = webhooks.OpsgenieConfig

OpsgenieConfig configures the service

type OrderActionsRequest

type OrderActionsRequest = actions.OrderActionsRequest

OrderActionsRequest is a request to order actions.

type OutgoingWebhookInputData

type OutgoingWebhookInputData = webhooks.OutgoingWebhookInputData

OutgoingWebhookInputData is the wrapped data for the webhooks.

type Owner

type Owner = apikeys.Owner

Owner is an owner of an API key.

type OwnerOrganisationID

type OwnerOrganisationID = apikeys.Owner_OrganisationId

OwnerOrganisationID is an owner organisation ID.

type OwnerTeamID

type OwnerTeamID = apikeys.Owner_TeamId

OwnerTeamID is an owner team ID.

type OwnerUserID

type OwnerUserID = apikeys.Owner_UserId

OwnerUserID is an owner user ID.

type PagerDuty

PagerDuty is a Webhook Type

type PagerDutyConfig

type PagerDutyConfig = webhooks.PagerDutyConfig

PagerDutyConfig configures the service

type PinDashboardRequest

type PinDashboardRequest = dashboards.PinDashboardRequest

PinDashboardRequest is a request to pin a dashboard.

type QueryRequest

type QueryRequest = dataprime.QueryRequest

QueryRequest is for running the query

type ReplaceActionRequest

type ReplaceActionRequest = actions.ReplaceActionRequest

ReplaceActionRequest is a request to replace an action.

type ReplaceDashboardRequest

type ReplaceDashboardRequest = dashboards.ReplaceDashboardRequest

ReplaceDashboardRequest is a request to replace a dashboard.

type ReplaceServiceSloRequest

type ReplaceServiceSloRequest = slos.ReplaceServiceSloRequest

ReplaceServiceSloRequest is a request to replace an SLO.

type RetentionPolicyRequest

type RetentionPolicyRequest = archiveMetrics.RetentionPolicyRequest

RetentionPolicyRequest is a request to set the retention policy.

type RuleGroupsClient

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

RuleGroupsClient is a client for the Coralogix Rules Groups API.

func NewRuleGroupsClient

func NewRuleGroupsClient(c *CallPropertiesCreator) *RuleGroupsClient

NewRuleGroupsClient creates a new rule groups client.

func (RuleGroupsClient) Create

Create creates a new rule group.

func (RuleGroupsClient) Delete

Delete deletes a rule group.

func (RuleGroupsClient) Get

Get gets a rule group.

func (RuleGroupsClient) Update

Update updates a rule group.

type SCIMUser

type SCIMUser struct {
	Schemas  []string        `json:"schemas"`
	ID       *string         `json:"id,omitempty"`
	UserName string          `json:"userName"`
	Active   bool            `json:"active"`
	Name     *SCIMUserName   `json:"name,omitempty"`
	Groups   []SCIMUserGroup `json:"groups,omitempty"`
	Emails   []SCIMUserEmail `json:"emails,omitempty"`
}

SCIMUser represents a SCIM User

type SCIMUserEmail

type SCIMUserEmail struct {
	Value   string `json:"value"`
	Primary bool   `json:"primary"`
	Type    string `json:"type"`
}

SCIMUserEmail represents a SCIM User Email

type SCIMUserGroup

type SCIMUserGroup struct {
	Value string `json:"value"`
}

SCIMUserGroup represents a SCIM User Group

type SCIMUserName

type SCIMUserName struct {
	GivenName  string `json:"givenName"`
	FamilyName string `json:"familyName"`
}

SCIMUserName represents a SCIM User Name

type SLOsClient

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

SLOsClient is a client for the Coralogix SLOs API.

func NewSLOsClient

func NewSLOsClient(c *CallPropertiesCreator) *SLOsClient

NewSLOsClient creates a new SLOs client.

func (SLOsClient) Create

Create creates a new SLO.

func (SLOsClient) Delete

Delete deletes the specified SLO.

func (SLOsClient) Get

Get gets the specified SLO.

func (SLOsClient) GetBulk

GetBulk gets multiple SLOs in a single call.

func (SLOsClient) List

List lists all service SLOs.

func (SLOsClient) Update

Update updates the specified SLO.

type SaveIntegrationRequest

type SaveIntegrationRequest = ext.SaveIntegrationRequest

SaveIntegrationRequest is a request to create an integration.

type Schedule

type Schedule = alertsSchedulers.Schedule

Schedule is a schedule.

type ScheduleOneTime

type ScheduleOneTime = alertsSchedulers.Schedule_OneTime

ScheduleOneTime is a one-time schedule container.

type ScopesClient

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

ScopesClient is a client for the scopes service

func NewScopesClient

func NewScopesClient(c *CallPropertiesCreator) *ScopesClient

NewScopesClient creates a new ScopesClient

func (ScopesClient) Create

Create creates a new scope

func (ScopesClient) Delete

Delete deletes a scope

func (ScopesClient) Get

Get gets a scope by its ID

func (ScopesClient) List

List lists all scopes for the current team

func (ScopesClient) Update

Update updates a scope

type SendLog

SendLog is a Webhook Type

type SendLogConfig

type SendLogConfig = webhooks.SendLogConfig

SendLogConfig configures the service

type ServiceSlo

type ServiceSlo = slos.ServiceSlo

ServiceSlo is an SLO.

type ServiceSloErrorSli

type ServiceSloErrorSli = slos.ServiceSlo_ErrorSli

ServiceSloErrorSli is an SLO error SLI.

type SetActiveRequest

type SetActiveRequest = alerts.SetActiveRequest

SetActiveRequest is a request to set the active status of an alert.

type SetDailyQuotaRequest

type SetDailyQuotaRequest = teams.SetDailyQuotaRequest

SetDailyQuotaRequest is a request to set the daily quota for a team.

type Slack

Slack is a Webhook Type

type SlackConfig

type SlackConfig = webhooks.SlackConfig

SlackConfig is a config

type SlackConfigAttachment

type SlackConfigAttachment = webhooks.SlackConfig_Attachment

SlackConfigAttachment is a config

type SlackConfigDigest

type SlackConfigDigest = webhooks.SlackConfig_Digest

SlackConfigDigest is a config

type SyncRumDataRequest

type SyncRumDataRequest = ext.SyncRumDataRequest

SyncRumDataRequest is a request to sync RUM data.

type TCOPoliciesClient

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

TCOPoliciesClient is a client for the Coralogix TCO Policies API.

func NewTCOPoliciesClient

func NewTCOPoliciesClient(c *CallPropertiesCreator) *TCOPoliciesClient

NewTCOPoliciesClient Creates a new TCO policies client.

func (TCOPoliciesClient) CreateTCOPolicy

CreateTCOPolicy creates a new TCO policy.

func (TCOPoliciesClient) DeleteTCOPolicy

DeleteTCOPolicy deletes the specified TCO policy.

func (TCOPoliciesClient) GetTCOPolicies

GetTCOPolicies gets the specified TCO logs policies.

func (TCOPoliciesClient) GetTCOPolicy

GetTCOPolicy gets the specified TCO policy.

func (TCOPoliciesClient) OverwriteTCOLogsPolicies

OverwriteTCOLogsPolicies overwrites the specified TCO logs policies.

func (TCOPoliciesClient) OverwriteTCOTracesPolicies

OverwriteTCOTracesPolicies overwrites the specified TCO traces policies.

func (TCOPoliciesClient) ReorderTCOPolicies

ReorderTCOPolicies reorders the specified TCO policies.

func (TCOPoliciesClient) UpdateTCOPolicy

UpdateTCOPolicy updates the specified TCO policy.

type TeamID

type TeamID = teams.TeamId

TeamID identifies a team.

type TeamsClient

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

TeamsClient is a client for the Coralogix Teams API.

func NewTeamsClient

func NewTeamsClient(c *CallPropertiesCreator) *TeamsClient

NewTeamsClient creates a new teams client.

func (TeamsClient) Create

Create creates a new team.

func (TeamsClient) Delete

Delete deletes a team.

func (TeamsClient) Get

Get gets a team.

func (TeamsClient) GetQuota

GetQuota gets the quota for a team.

func (TeamsClient) MoveQuota

MoveQuota moves the quota from one team to another.

func (TeamsClient) SetDailyQuota

SetDailyQuota sets the daily quota for a team.

func (TeamsClient) Update

Update updates a team.

type TenantConfigV2Ibm

type TenantConfigV2Ibm = archiveMetrics.TenantConfigV2_Ibm

TenantConfigV2Ibm is a type to view the IBM storage config.

type TenantConfigV2S3

type TenantConfigV2S3 = archiveMetrics.TenantConfigV2_S3

TenantConfigV2S3 is a type to view the S3 bucket config.

type TestExistingOutgoingWebhookRequest

type TestExistingOutgoingWebhookRequest = webhooks.TestExistingOutgoingWebhookRequest

TestExistingOutgoingWebhookRequest is a request to test an existing webhook.

type TestIntegrationRequest

type TestIntegrationRequest = ext.TestIntegrationRequest

TestIntegrationRequest is a request to test an integration.

type TestOutgoingWebhookFailure

type TestOutgoingWebhookFailure = webhooks.TestOutgoingWebhookResponse_Failure

TestOutgoingWebhookFailure response for testing a webhook

type TestOutgoingWebhookRequest

type TestOutgoingWebhookRequest = webhooks.TestOutgoingWebhookRequest

TestOutgoingWebhookRequest is a request to test a webhook.

type TestOutgoingWebhookSuccess

type TestOutgoingWebhookSuccess = webhooks.TestOutgoingWebhookResponse_Success

TestOutgoingWebhookSuccess response for testing a webhook

type Timeframe

type Timeframe = alertsSchedulers.Timeframe

Timeframe is a timeframe.

type TimeframeEndTime

type TimeframeEndTime = alertsSchedulers.Timeframe_EndTime

TimeframeEndTime is the end time of a timeframe.

type UnpinDashboardRequest

type UnpinDashboardRequest = dashboards.UnpinDashboardRequest

UnpinDashboardRequest is a request to unpin a dashboard.

type UpdateAPIKeyRequest

type UpdateAPIKeyRequest = apikeys.UpdateApiKeyRequest

UpdateAPIKeyRequest is a request to update an API key.

type UpdateAlertSchedulerRuleRequest

type UpdateAlertSchedulerRuleRequest = alertsSchedulers.UpdateAlertSchedulerRuleRequest

UpdateAlertSchedulerRuleRequest is a request to update an alert scheduler rule.

type UpdateDataSetRequest

type UpdateDataSetRequest = enrichment.UpdateCustomEnrichmentRequest

UpdateDataSetRequest is a request to update a data set.

type UpdateIntegrationRequest

type UpdateIntegrationRequest = ext.UpdateIntegrationRequest

UpdateIntegrationRequest is a request to update an integration.

type UpdateOutgoingWebhookRequest

type UpdateOutgoingWebhookRequest = webhooks.UpdateOutgoingWebhookRequest

UpdateOutgoingWebhookRequest is a request to update a webhook.

type UpdateRequestIbm

type UpdateRequestIbm = archiveMetrics.UpdateRequest_Ibm

UpdateRequestIbm is a type to update the IBM storage.

type UpdateRequestS3

type UpdateRequestS3 = archiveMetrics.UpdateRequest_S3

UpdateRequestS3 is a type to update the S3 bucket.

type UpdateScopeRequest

type UpdateScopeRequest = scopes.UpdateScopeRequest

UpdateScopeRequest is a request to update a scope

type UpdateTeamRequest

type UpdateTeamRequest = teams.UpdateTeamRequest

UpdateTeamRequest is a request to update a team.

type UpdateTenantRequest

type UpdateTenantRequest = archiveMetrics.UpdateRequest

UpdateTenantRequest is a request to update the tenant.

type UsersClient

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

UsersClient is a client for the SCIM Users API

func NewUsersClient

func NewUsersClient(c *CallPropertiesCreator) *UsersClient

NewUsersClient creates a new UsersClient

func (UsersClient) Create

func (c UsersClient) Create(ctx context.Context, userReq *SCIMUser) (*SCIMUser, error)

Create creates a new SCIM User

func (UsersClient) Delete

func (c UsersClient) Delete(ctx context.Context, userID string) error

Delete deletes a SCIM User by ID

func (UsersClient) Get

func (c UsersClient) Get(ctx context.Context, userID string) (*SCIMUser, error)

Get retrieves a SCIM User by ID

func (UsersClient) Update

func (c UsersClient) Update(ctx context.Context, userID string, userReq *SCIMUser) (*SCIMUser, error)

Update updates a SCIM User by ID

type ValidateBucketRequest

type ValidateBucketRequest = archiveMetrics.ValidateBucketRequest

ValidateBucketRequest is a request to validate the bucket.

type ValidateBucketRequestIbm

type ValidateBucketRequestIbm = archiveMetrics.ValidateBucketRequest_Ibm

ValidateBucketRequestIbm is a request to validate the IBM storage.

type ValidateBucketRequestS3

type ValidateBucketRequestS3 = archiveMetrics.ValidateBucketRequest_S3

ValidateBucketRequestS3 is a request to validate the S3 bucket.

type WebhookType

type WebhookType = webhooks.WebhookType

WebhookType ... is the type of webhook

type WebhooksClient

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

WebhooksClient is a client for the Coralogix Webhooks API.

func NewWebhooksClient

func NewWebhooksClient(c *CallPropertiesCreator) *WebhooksClient

NewWebhooksClient creates a new webhooks client.

func (WebhooksClient) Create

Create creates a new webhook.

func (WebhooksClient) Delete

Delete deletes the specified webhook.

func (WebhooksClient) Get

Get gets the specified webhook.

func (WebhooksClient) List

List lists all webhooks.

func (WebhooksClient) ListTypes

ListTypes lists all webhook types.

func (WebhooksClient) Replace

Replace replaces the specified webhook.

func (WebhooksClient) Test

Test tests the included webhook.

func (WebhooksClient) TestByID

TestByID tests an existing webhook.

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

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