# Functions
NewClient creates a new Sysdig Client and applies all provided ClientOption.
NewDashboard constructs an empty Dashboard with the given name.
NewMicroDuration creates a new MicroDuration with the provided time.Duration.
NewMilliTime creates a new MilliTime with the provided time.Time.
UnixMilli returns the local MilliTime corresponding to the given Unix time in milliseconds.
WithBaseURL sets the Client.BaseURL to the provided URL.
WithDebug sets whether to print debug information about requests and responses.
WithHTTPClient sets the HTTP client for the Sysdig client.
WithIBMBaseURL sets the Client.BaseURL to the BaseURL associated with the provided IBM Region and network.
WithLogger sets the default logger for the Client.
WithResponseCompression sets whether to set compression headers in requests to Sysdig.
WithUserAgent sets the User Agent to be sent to Sysdig.
# Constants
AlertTypeEvent means the Alert is from an Event.
CategoryAlert are Events coming from Alerts.
CategoryContainerd are events emitted by containerd.
CategoryCustom are custom events sent by the user.
CategoryDocker are events emitted by Docker.
CategoryKubernetes are events emitted by Kubernetes.
DirectionAfter will order a list of events by newest age first (?).
DirectionBefore will order a list of events by oldest age first (?).
NotificationChannelTypeEmail is a notification channel which sends to email.
NotificationChannelTypeOpsGenie is a notification channel which sends to OpsGenie.
NotificationChannelTypePagerDuty is a notification channel which sends to Pagerduty.
NotificationChannelTypeSlack is a notification channel which sends to Slack.
NotificationChannelTypeSNS is a notification channel which sends to Amazon SNS.
NotificationChannelTypeVictorOps is a notification channel which sends to VictorOps.
NotificationChannelTypeWebhook is a notification channel which sends to a webhook.
ProductTypeAny is an empty product code to allow for searching across all products.
ProductTypeMonitor is the product code for Sysdig Monitor.
ProductTypeSecure is the product code for Sysdig Secure.
RegionAUSYD is the IBM region au-syd, located in Sydney.
RegionBRSAO is the IBM region br-sao, located in São Paulo.
RegionCATOR is the IBM region ca-tor, located in Toronto.
RegionEUDE is the IBM region eu-de, located in Frankfurt.
RegionJPOSA is the IBM region jp-osa, located in Osaka.
RegionJPTOK is the IBM region jp-tok, located in Tokyo.
RegionUSEast is the IBM region us-east, located in Washington, DC.
RegionUSSouth is the IBM region us-south, located in Dallas.
SeverityAlert should be corrected immediately - notify staff who can fix the problem - example is loss of backup ISP connection.
SeverityCritical should be corrected immediately, but indicates failure in a primary system - fix CRITICAL problems before ALERT - example is loss of primary ISP connection.
SeverityDebug is info useful to developers for debugging the app, not useful during operations.
SeverityEmergency is a "panic" condition - notify all tech staff on call? (Earthquake? Tornado?) - affects multiple apps/servers/sites.
SeverityError is a non-urgent failure - these should be relayed to developers or admins; each item must be resolved within a given time.
SeverityHigh is a high severity alert.
SeverityInfo are normal operational messages - may be harvested for reporting, measuring throughput, etc.
SeverityInformational are normal operational messages - may be harvested for reporting, measuring throughput, etc.
SeverityLow is a low severity alert.
SeverityMedium is a medium severity alert.
SeverityNone is an event without any specified SeverityLabel.
SeverityNotice are events that are unusual but not error conditions - might be summarized in an email to developers or admins to spot potential problems - no immediate action required.
SeverityWarning are warning messages - not an error, but indication that an error will occur if action is not taken, e.g.
StatusAcknowledged is an event status indicating that the event has been acknowledged by the user.
StatusResolved is an event status indicating that the event has been resolved.
StatusTriggered is an event status indicating the event has not been acknowledged.
StatusUnacknowledged is an event status indicating that the event has been unacknowledged by the user.
# Structs
Agent is a Sysdig Agent.
AgentInstallParams are the agent installation parameters for a User.
Alert defines a Sysdig Alert.
AlertCriteria defines the Criteria for an Alert.
AlertCustomNotification is the structure for a Custom Notification on an Alert.
AlertResponse is a container for an Alert returned by the Sysdig API.
AxesConfiguration is the configuration for the axes of a Panel in a Dashboard.
Axis is an axis configuration used in an AxesConfiguration for the axes of a Panel in a Dashboard.
BasicQuery is a basic query type used in a Dashboard.
BasicQueryCompareTo is used in a BasicQuery on a Dashboard.
BasicQueryDisplayInfo is the display info used in a BasicQuery on a Dashboard.
BasicQueryFormat is the metric format used in a BasicQuery on a Dashboard.
BasicQueryMetric is a metric used in a BasicQuery on a Dashboard.
BasicQueryScope is a scope used in a BasicQuery on a Dashboard.
BasicQuerySegmentation is the segmentation used in a BasicQuery on a Dashboard.
BasicQuerySegmentationLabel is a segmentation label used in a BasicQuerySegmentation of a BasicQuery on a Dashboard.
Client manages communication with the Sysdig API.
ConnectedAgentsResponse describes the response for UsersService.ConnectedAgents.
Customer is the customer information for a User.
CustomerSettings are the customer related settings for a user.
Dashboard is the structure for a Sysdig Dashboard.
DashboardResponse is a container for a Dashboard returned by the DashboardService API.
DashboardTransferResponse is a container for a DashboardTransferResults for the DashboardService.Transfer API.
DashboardTransferResults is the response structure for the DashboardService.Transfer API.
Error contains a further explanation for the reason of an error..
ErrorResponse reports one or more errors caused by an API request.
Event describes an event from the Sysdig API.
EventDisplaySettings are the event display settings for a Dashboard.
EventDisplaySettingsQueryParams are the query parameters used in an EventDisplaySettings for a Dashboard.
EventOptions are the parameters that make up an Event.
EventResponse describes an EventResponse returned from the Sysdig API.
Infrastructure is metrics about the infrastructure monitored by Sysdig for this team.
InfrastructureAgentMetricOverviews is an overview for Sysdig agents in an TeamsService.Infrastructure response.
InfrastructureMetricCount is overview of infrastructure metrics in an TeamsService.Infrastructure response.
InfrastructureResponse is an Infrastructure container for the TeamsService.Infrastructure API.
Layout defines the Layout of Panels a Dashboard.
LegacyLimits are legacy limits for a User.
LegendConfiguration is the configuration for a legend on a Panel in a Dashboard.
Limits are limits for a User.
ListAlertConfigurationsResponse describes the response for AlertsService.List.
ListDashboardsResponse is a container for Dashboards returned by the DashboardService.List API.
ListEventOptions defines the search parameters for EventsService.List.
ListEventsResponse describes a response returned from the Sysdig List API.
ListNotificationChannelsResponse describes the response for NotificationChannelsService.List.
ListTeamsResponse is a container of Teams for the TeamsService.List API.
ListUsersResponse is a container for User returned by the TeamsService.ListUsers API.
MeResponse describes the response for UsersService.Me.
MetricsSettings are the metrics settings for a User.
MicroDuration is a custom time.Duration which implements transforming between time.Duration's default representation and Sysdig's expected Microsecond duration format for timespans.
MilliTime is a custom time.Time which implements transforming between time.Time's default representation and Sysdig's expected time.UnixMillis representation.
NotificationChannel describes a Sysdig notification channel.
NotificationChannelOptions describes the options for a NotificationChannel.
NotificationChannelResponse describes the response for a NotificationChannel from the NotificationChannelsService API.
OnPremOverview is information about the on-premises installation of Sysdig in an TeamsService.Infrastructure response.
Panel is the structure of a Panel in a Dashboard.
PaymentsIntegrationID is the ID of the payment integration for this User.
Plan is the plan for a User.
ScopeExpression is a scope expression used in a Dashboard.
SharingMember defines a sharing member for a Dashboard.
SharingSetting defines a sharing setting for a Dashboard.
Team is the structure for a Sysdig Team.
TeamEntryPoint is the entrypoint for this Team.
TeamResponse is a container for a Team in the TeamsService.Get API.
TeamRole is the role for a User in a Team.
ThresholdBase is a threshold base for a Thresholds on a Panel in a Dashboard.
Thresholds are the threshold for a Panel on a Dashboard.
ThresholdValue is a threshold value for a Thresholds on a Panel in a Dashboard.
Timeline are the sampling timelines for a Plan.
Token is a Sysdig token.
TokenResponse describes the response for UsersService.Token.
TTL is the PaymentsIntegrationID TTL.
User defines a Sysdig User.
UserProperties are the properties for a User.
UserSysdigSettings are the Sysdig settings for a user.
# Interfaces
Logger is the interface for logging used by the Client.
# Type aliases
AlertService is the Service for communicating with the Sysdig Monitor Alert related API.
AlertType defines the types of Alerts.
Categories is a type encapsulating a slice of Category to allow for easy marshalling into the proper JSON field.
Category is an event category.
ClientOption defines the options for a Sysdig Client.
DashboardService is the Service for communicating with the Sysdig Monitor Dashboard related API.
Direction defines the ordering of a list of events.
EventsService is the Service for communicating with the Sysdig Events API.
NotificationChannelsService is the Service for communicating with the Sysdig Monitor Notification Channel related API.
NotificationChannelType is a type of Sysdig notification channel.
ProductType defines the Sysdig product types.
Region is a type for defining available IBM regions for Sysdig.
Severity is the severity level for the Event.
SeverityLabel is the severity level label for an Event.
Status is an event status.
TeamsService is the Service for communicating with the Sysdig Monitor Team related API.
UsersService is the Service for communicating with the Sysdig Monitor User related API.