signalfx

package module
v1.34.0 Latest Latest
Warning

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

 Go to latest Published: Jan 5, 2024 License: Apache-2.0 Imports: 26 Imported by: 2

README

ℹ️  SignalFx was acquired by Splunk in October 2019. See Splunk SignalFx for more information.

Go client library for SignalFx

GoDoc

This is a programmatic interface in Go for SignalFx's metadata and ingest APIs.

SignalFlow

There is an experimental SignalFlow client in the signalflow directory. An example of its use is in [signalflow/example]. For full documentation see the godocs.

Example

import "github.com/signalfx/signalfx-go"

// The client can be customized by backing options onto the end. Check the
// godoc for more info!

// Instantiate your own client if you want to customize its options
// or test with a RoundTripper
httpClient := &http.Client{…}
client := signalfx.NewClient("your-token-here", HTTPClient(httpClient))

// Then do things!
chart, err := client.GetChart("abc123IdHere")

Questions

Why are there some things missing?

We're working on it, feel free to file an issue if an endpoint is missing!

Why are the class names sometimes long and the source file names prefixed with model_?

The request and response bodies for this library are machine generated from our OpenAPI specs using OpenAPI code generator. This is a real boon for everyone, keeping the documentation as a source of truth and ensuring that this library has support for all the things!

This means that some of our type names are verbose. It's fine, you only type code once and the benefits are worth it.

Documentation

Index

Constants

View Source 
const AlertMutingRuleAPIURL = "/v2/alertmuting"

AlertMutingRuleAPIURL is the base URL for interacting with alert muting rules.

View Source 
const AuthHeaderKey = "X-Sf-Token"

AuthHeaderKey is the HTTP header used to pass along the auth token Note that while HTTP headers are case insensitive this header is case sensitive on the tests for convenience.

View Source 
const ChartAPIURL = "/v2/chart"

ChartAPIURL is the base URL for interacting with charts.

View Source 
const DashboardAPIURL = "/v2/dashboard"

DashboardAPIURL is the base URL for interacting with dashboard.

View Source 
const DashboardGroupAPIURL = "/v2/dashboardgroup"

DashboardGroupAPIURL is the base URL for interacting with dashboard.

View Source 
const DataLinkAPIURL = "/v2/crosslink"

DataLinkAPIURL is the base URL for interacting with data link.

View Source 
const DefaultAPIURL = "https://api.signalfx.com"

DefaultAPIURL is the default URL for making API requests

View Source 
const DetectorAPIURL = "/v2/detector"

DetectorAPIURL is the base URL for interacting with detectors.

View Source 
const DimensionAPIURL = "/v2/dimension"

DimensionAPIURL is the base URL for interacting with dimensions.

View Source 
const IncidentAPIURL = "/v2/incident"

IncidentAPIURL is the base URL for interacting with alert muting rules.

View Source 
const IntegrationAPIURL = "/v2/integration"

IntegrationAPIURL is the base URL for interacting with integrations.

View Source 
const MetricAPIURL = "/v2/metric"

MetricAPIURL is the base URL for interacting with dimensions.

View Source 
const MetricRulesetApiURL = "/v2/metricruleset"

MetricRulesetApiURL is the base URL for interacting with metric rulesets.

View Source 
const MetricTimeSeriesAPIURL = "/v2/metrictimeseries"

MetricTimeSeriesAPIURL is the base URL for interacting with dimensions.

View Source 
const OrganizationAPIURL = "/v2/organization"

OrganizationAPIURL is the base URL for interacting with detectors.

View Source 
const OrganizationMemberAPIURL = "/v2/organization/member"
View Source 
const OrganizationMembersAPIURL = "/v2/organization/members"
View Source 
const SessionTokenAPIURL = "/v2/session"

SessionTokenAPIURL is the base URL for interacting with org tokens.

View Source 
const SloAPIURL = "/v2/slo"
View Source 
const TagAPIURL = "/v2/tag"

TagAPIURL is the base URL for interacting with dimensions.

View Source 
const TeamAPIURL = "/v2/team"

TeamAPIURL is the base URL for interacting with teams.

View Source 
const TokenAPIURL = "/v2/token"

TokenAPIURL is the base URL for interacting with org tokens.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

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

Client is a SignalFx API client.

func NewClient 

func NewClient(token string, options ...ClientParam) (*Client, error)

NewClient creates a new SignalFx client using the specified token.

func (*Client) CreateAWSCloudWatchIntegration added in v1.3.0 

func (c *Client) CreateAWSCloudWatchIntegration(ctx context.Context, acwi *integration.AwsCloudWatchIntegration) (*integration.AwsCloudWatchIntegration, error)

CreateAWSCloudWatchIntegration creates an AWS CloudWatch integration.

func (*Client) CreateAlertMutingRule added in v1.6.8 

func (c *Client) CreateAlertMutingRule(ctx context.Context, muteRequest *alertmuting.CreateUpdateAlertMutingRuleRequest) (*alertmuting.AlertMutingRule, error)

CreateAlertMutingRule creates an alert muting rule.

func (*Client) CreateAzureIntegration added in v1.4.0 

func (c *Client) CreateAzureIntegration(ctx context.Context, acwi *integration.AzureIntegration) (*integration.AzureIntegration, error)

CreateAzureIntegration creates an Azure integration.

func (*Client) CreateChart 

func (c *Client) CreateChart(ctx context.Context, chartRequest *chart.CreateUpdateChartRequest) (*chart.Chart, error)

CreateChart creates a chart.

func (*Client) CreateDashboard 

func (c *Client) CreateDashboard(ctx context.Context, dashboardRequest *dashboard.CreateUpdateDashboardRequest) (*dashboard.Dashboard, error)

CreateDashboard creates a dashboard.

func (*Client) CreateDashboardGroup 

func (c *Client) CreateDashboardGroup(ctx context.Context, dashboardGroupRequest *dashboard_group.CreateUpdateDashboardGroupRequest, skipImplicitDashboard bool) (*dashboard_group.DashboardGroup, error)

CreateDashboardGroup creates a dashboard. 

func (c *Client) CreateDataLink(ctx context.Context, dataLinkRequest *datalink.CreateUpdateDataLinkRequest) (*datalink.DataLink, error)

CreateDataLink creates a data link.

func (*Client) CreateDetector 

func (c *Client) CreateDetector(ctx context.Context, detectorRequest *detector.CreateUpdateDetectorRequest) (*detector.Detector, error)

CreateDetector creates a detector.

func (*Client) CreateGCPIntegration added in v1.6.0 

func (c *Client) CreateGCPIntegration(ctx context.Context, gcpi *integration.GCPIntegration) (*integration.GCPIntegration, error)

CreateGCPIntegration creates a GCP integration.

func (*Client) CreateJiraIntegration added in v1.6.5 

func (c *Client) CreateJiraIntegration(ctx context.Context, ji *integration.JiraIntegration) (*integration.JiraIntegration, error)

CreateJiraIntegration creates an Jira integration.

func (*Client) CreateMetricRuleset added in v1.27.0 

func (c *Client) CreateMetricRuleset(ctx context.Context, metricRuleset *metric_ruleset.CreateMetricRulesetRequest) (*metric_ruleset.CreateMetricRulesetResponse, error)

CreateMetricRuleset creates a metric ruleset.

func (*Client) CreateOpsgenieIntegration added in v1.6.0 

func (c *Client) CreateOpsgenieIntegration(ctx context.Context, oi *integration.OpsgenieIntegration) (*integration.OpsgenieIntegration, error)

CreateOpsgenieIntegration creates an Opsgenie integration.

func (*Client) CreateOrgToken added in v1.5.0 

func (c *Client) CreateOrgToken(ctx context.Context, tokenRequest *orgtoken.CreateUpdateTokenRequest) (*orgtoken.Token, error)

CreateOrgToken creates a org token.

func (*Client) CreatePagerDutyIntegration added in v1.6.0 

func (c *Client) CreatePagerDutyIntegration(ctx context.Context, pdi *integration.PagerDutyIntegration) (*integration.PagerDutyIntegration, error)

CreatePagerDutyIntegration creates a PagerDuty integration.

func (*Client) CreateServiceNowIntegration added in v1.12.0 

func (c *Client) CreateServiceNowIntegration(ctx context.Context, in *integration.ServiceNowIntegration) (*integration.ServiceNowIntegration, error)

CreateServiceNowIntegration creates SNOW integration.

func (*Client) CreateSessionToken added in v1.6.11 

func (c *Client) CreateSessionToken(ctx context.Context, tokenRequest *sessiontoken.CreateTokenRequest) (*sessiontoken.Token, error)

CreateOrgToken creates a org token.

func (*Client) CreateSlackIntegration added in v1.6.0 

func (c *Client) CreateSlackIntegration(ctx context.Context, si *integration.SlackIntegration) (*integration.SlackIntegration, error)

CreateSlackIntegration creates a Slack integration.

func (*Client) CreateSlo added in v1.34.0 

func (c *Client) CreateSlo(ctx context.Context, sloRequest *slo.SloObject) (*slo.SloObject, error)

func (*Client) CreateTeam 

func (c *Client) CreateTeam(ctx context.Context, t *team.CreateUpdateTeamRequest) (*team.Team, error)

CreateTeam creates a team.

func (*Client) CreateUpdateMetric added in v1.8.1 

func (c *Client) CreateUpdateMetric(ctx context.Context, name string, cumr *metrics_metadata.CreateUpdateMetricRequest) (*metrics_metadata.Metric, error)

UpdateMetric creates or updates a metric

func (*Client) CreateUpdateTag 

func (c *Client) CreateUpdateTag(ctx context.Context, name string, cutr *metrics_metadata.CreateUpdateTagRequest) (*metrics_metadata.Tag, error)

CreateUpdateTag creates or updates a dimension.

func (*Client) CreateVictorOpsIntegration added in v1.6.2 

func (c *Client) CreateVictorOpsIntegration(ctx context.Context, oi *integration.VictorOpsIntegration) (*integration.VictorOpsIntegration, error)

CreateVictorOpsIntegration creates an VictorOps integration.

func (*Client) CreateWebhookIntegration added in v1.6.19 

func (c *Client) CreateWebhookIntegration(ctx context.Context, oi *integration.WebhookIntegration) (*integration.WebhookIntegration, error)

CreateWebhookIntegration creates an Webhook integration.

func (*Client) DeleteAWSCloudWatchIntegration added in v1.3.0 

func (c *Client) DeleteAWSCloudWatchIntegration(ctx context.Context, id string) error

DeleteAWSCloudWatchIntegration deletes an AWS CloudWatch integration.

func (*Client) DeleteAlertMutingRule added in v1.6.8 

func (c *Client) DeleteAlertMutingRule(ctx context.Context, name string) error

DeleteAlertMutingRule deletes an alert muting rule.

func (*Client) DeleteAzureIntegration added in v1.4.0 

func (c *Client) DeleteAzureIntegration(ctx context.Context, id string) error

DeleteAzureIntegration deletes an Azure integration.

func (*Client) DeleteChart 

func (c *Client) DeleteChart(ctx context.Context, id string) error

DeleteChart deletes a chart.

func (*Client) DeleteDashboard 

func (c *Client) DeleteDashboard(ctx context.Context, id string) error

DeleteDashboard deletes a dashboard.

func (*Client) DeleteDashboardGroup 

func (c *Client) DeleteDashboardGroup(ctx context.Context, id string) error

DeleteDashboardGroup deletes a dashboard. 

func (c *Client) DeleteDataLink(ctx context.Context, id string) error

DeleteDataLink deletes a data link.

func (*Client) DeleteDetector 

func (c *Client) DeleteDetector(ctx context.Context, id string) error

DeleteDetector deletes a detector.

func (*Client) DeleteGCPIntegration added in v1.6.0 

func (c *Client) DeleteGCPIntegration(ctx context.Context, id string) error

DeleteGCPIntegration deletes a GCP integration.

func (*Client) DeleteIntegration 

func (c *Client) DeleteIntegration(ctx context.Context, id string) error

DeleteIntegration deletes an integration.

func (*Client) DeleteJiraIntegration added in v1.6.5 

func (c *Client) DeleteJiraIntegration(ctx context.Context, id string) error

DeleteJiraIntegration deletes an Jira integration.

func (*Client) DeleteMember 

func (c *Client) DeleteMember(ctx context.Context, id string) error

DeleteMember deletes a detector.

func (*Client) DeleteMetricRuleset added in v1.27.0 

func (c *Client) DeleteMetricRuleset(ctx context.Context, id string) error

DeleteMetricRuleset deletes a metric ruleset.

func (*Client) DeleteOpsgenieIntegration added in v1.6.0 

func (c *Client) DeleteOpsgenieIntegration(ctx context.Context, id string) error

DeleteOpsgenieIntegration deletes an Opsgenie integration.

func (*Client) DeleteOrgToken added in v1.5.0 

func (c *Client) DeleteOrgToken(ctx context.Context, name string) error

DeleteOrgToken deletes a token.

func (*Client) DeletePagerDutyIntegration added in v1.6.0 

func (c *Client) DeletePagerDutyIntegration(ctx context.Context, id string) error

DeletePagerDutyIntegration deletes a PagerDuty integration.

func (*Client) DeleteServiceNowIntegration added in v1.12.0 

func (c *Client) DeleteServiceNowIntegration(ctx context.Context, id string) error

DeleteServiceNowIntegration deletes SNOW integration.

func (*Client) DeleteSessionToken added in v1.6.11 

func (c *Client) DeleteSessionToken(ctx context.Context, token string) error

DeleteOrgToken deletes a token.

func (*Client) DeleteSlackIntegration added in v1.6.0 

func (c *Client) DeleteSlackIntegration(ctx context.Context, id string) error

DeleteSlackIntegration deletes a Slack integration.

func (*Client) DeleteSlo added in v1.34.0 

func (c *Client) DeleteSlo(ctx context.Context, id string) error

func (*Client) DeleteTag 

func (c *Client) DeleteTag(ctx context.Context, id string) error

DeleteTag deletes a tag.

func (*Client) DeleteTeam 

func (c *Client) DeleteTeam(ctx context.Context, id string) error

DeleteTeam deletes a team.

func (*Client) DeleteVictorOpsIntegration added in v1.6.2 

func (c *Client) DeleteVictorOpsIntegration(ctx context.Context, id string) error

DeleteVictorOpsIntegration deletes an VictorOps integration.

func (*Client) DeleteWebhookIntegration added in v1.6.19 

func (c *Client) DeleteWebhookIntegration(ctx context.Context, id string) error

DeleteWebhookIntegration deletes an Webhook integration.

func (*Client) DisableDetector 

func (c *Client) DisableDetector(ctx context.Context, id string, labels []string) error

DisableDetector disables a detector.

func (*Client) EnableDetector 

func (c *Client) EnableDetector(ctx context.Context, id string, labels []string) error

EnableDetector enables a detector.

func (*Client) GenerateAggregationMetricName added in v1.27.0 

func (c *Client) GenerateAggregationMetricName(ctx context.Context, generateAggregationNameRequest metric_ruleset.GenerateAggregationNameRequest) (string, error)

func (*Client) GetAWSCloudWatchIntegration added in v1.3.0 

func (c *Client) GetAWSCloudWatchIntegration(ctx context.Context, id string) (*integration.AwsCloudWatchIntegration, error)

GetAWSCloudWatchIntegration retrieves an AWS CloudWatch integration.

func (*Client) GetAlertMutingRule added in v1.6.8 

func (c *Client) GetAlertMutingRule(ctx context.Context, id string) (*alertmuting.AlertMutingRule, error)

GetAlertMutingRule gets an alert muting rule.

func (*Client) GetAzureIntegration added in v1.4.0 

func (c *Client) GetAzureIntegration(ctx context.Context, id string) (*integration.AzureIntegration, error)

GetAzureIntegration retrieves an Azure integration.

func (*Client) GetChart 

func (c *Client) GetChart(ctx context.Context, id string) (*chart.Chart, error)

GetChart gets a chart.

func (*Client) GetDashboard 

func (c *Client) GetDashboard(ctx context.Context, id string) (*dashboard.Dashboard, error)

GetDashboard gets a dashboard.

func (*Client) GetDashboardGroup 

func (c *Client) GetDashboardGroup(ctx context.Context, id string) (*dashboard_group.DashboardGroup, error)

GetDashboardGroup gets a dashboard group. 

func (c *Client) GetDataLink(ctx context.Context, id string) (*datalink.DataLink, error)

GetDataLink gets a data link.

func (*Client) GetDetector 

func (c *Client) GetDetector(ctx context.Context, id string) (*detector.Detector, error)

GetDetector gets a detector.

func (*Client) GetDetectorEvents added in v1.6.17 

func (c *Client) GetDetectorEvents(ctx context.Context, id string, from int, to int, offset int, limit int) ([]*detector.Event, error)

GetDetectorEvents gets a detector's events.

func (*Client) GetDetectorIncidents added in v1.6.17 

func (c *Client) GetDetectorIncidents(ctx context.Context, id string, offset int, limit int) ([]*detector.Incident, error)

GetDetectorIncidents gets a detector's incidents.

func (*Client) GetDimension 

func (c *Client) GetDimension(ctx context.Context, key string, value string) (*metrics_metadata.Dimension, error)

GetDimension gets a dimension.

func (*Client) GetGCPIntegration added in v1.6.0 

func (c *Client) GetGCPIntegration(ctx context.Context, id string) (*integration.GCPIntegration, error)

GetGCPIntegration retrieves a GCP integration.

func (*Client) GetIncident added in v1.20.0 

func (c *Client) GetIncident(ctx context.Context, id string) (*detector.Incident, error)

Get incident with the given id

func (*Client) GetIncidents added in v1.20.0 

func (c *Client) GetIncidents(ctx context.Context, includeResolved bool, limit int, query string, offset int) ([]*detector.Incident, error)

Get all incidents

func (*Client) GetIntegration 

func (c *Client) GetIntegration(ctx context.Context, id string) (map[string]interface{}, error)

GetIntegration gets an integration as map.

func (*Client) GetJiraIntegration added in v1.6.5 

func (c *Client) GetJiraIntegration(ctx context.Context, id string) (*integration.JiraIntegration, error)

GetJiraIntegration retrieves an Jira integration.

func (*Client) GetMember 

func (c *Client) GetMember(ctx context.Context, id string) (*organization.Member, error)

GetMember gets a member.

func (*Client) GetMetric 

func (c *Client) GetMetric(ctx context.Context, name string) (*metrics_metadata.Metric, error)

GetMetric retrieves a single metric by name.

func (*Client) GetMetricRuleset added in v1.27.0 

func (c *Client) GetMetricRuleset(ctx context.Context, id string) (*metric_ruleset.GetMetricRulesetResponse, error)

GetMetricRuleset gets a metric ruleset.

func (*Client) GetMetricTimeSeries 

func (c *Client) GetMetricTimeSeries(ctx context.Context, id string) (*metrics_metadata.MetricTimeSeries, error)

GetMetricTimeSeries retrieves a metric time series by id.

func (*Client) GetOpsgenieIntegration added in v1.6.0 

func (c *Client) GetOpsgenieIntegration(ctx context.Context, id string) (*integration.OpsgenieIntegration, error)

GetOpsgenieIntegration retrieves an Opsgenie integration.

func (*Client) GetOrgToken added in v1.5.0 

func (c *Client) GetOrgToken(ctx context.Context, id string) (*orgtoken.Token, error)

GetOrgToken gets a token.

func (*Client) GetOrganization 

func (c *Client) GetOrganization(ctx context.Context, id string) (*organization.Organization, error)

GetOrganization gets an organization.

func (*Client) GetOrganizationMembers 

func (c *Client) GetOrganizationMembers(ctx context.Context, limit int, query string, offset int, orderBy string) (*organization.MemberSearchResults, error)

GetOrganizationMembers gets members for an org, with an optional search.

func (*Client) GetPagerDutyIntegration added in v1.6.0 

func (c *Client) GetPagerDutyIntegration(ctx context.Context, id string) (*integration.PagerDutyIntegration, error)

GetPagerDutyIntegration retrieves a PagerDuty integration.

func (*Client) GetPagerDutyIntegrationByName added in v1.7.14 

func (c *Client) GetPagerDutyIntegrationByName(ctx context.Context, name string) (*integration.PagerDutyIntegration, error)

GetPagerDutyIntegrationByName retrieves a PagerDuty integration by name.

func (*Client) GetServiceNowIntegration added in v1.12.0 

func (c *Client) GetServiceNowIntegration(ctx context.Context, id string) (*integration.ServiceNowIntegration, error)

GetServiceNowIntegration retrieves SNOW integration.

func (*Client) GetSlackIntegration added in v1.6.0 

func (c *Client) GetSlackIntegration(ctx context.Context, id string) (*integration.SlackIntegration, error)

GetSlackIntegration retrieves a Slack integration.

func (*Client) GetSlo added in v1.34.0 

func (c *Client) GetSlo(ctx context.Context, id string) (*slo.SloObject, error)

func (*Client) GetTag 

func (c *Client) GetTag(ctx context.Context, name string) (*metrics_metadata.Tag, error)

GetTag gets a tag by name

func (*Client) GetTeam 

func (c *Client) GetTeam(ctx context.Context, id string) (*team.Team, error)

GetTeam gets a team.

func (*Client) GetVictorOpsIntegration added in v1.6.2 

func (c *Client) GetVictorOpsIntegration(ctx context.Context, id string) (*integration.VictorOpsIntegration, error)

GetVictorOpsIntegration retrieves an VictorOps integration.

func (*Client) GetWebhookIntegration added in v1.6.19 

func (c *Client) GetWebhookIntegration(ctx context.Context, id string) (*integration.WebhookIntegration, error)

GetWebhookIntegration retrieves an Webhook integration.

func (*Client) InviteMember 

func (c *Client) InviteMember(ctx context.Context, inviteRequest *organization.CreateUpdateMemberRequest) (*organization.Member, error)

InviteMember invites a member to the organization.

func (*Client) InviteMembers 

func (c *Client) InviteMembers(ctx context.Context, inviteRequest *organization.InviteMembersRequest) (*organization.InviteMembersRequest, error)

InviteMembers invites many members to the organization.

func (*Client) LinkDashboardGroupToTeam added in v1.7.8 

func (c *Client) LinkDashboardGroupToTeam(ctx context.Context, id string, dashboardGroupID string) error

LinkDashboardGroupToTeam links a dashboard group to a team.

func (*Client) LinkDetectorToTeam added in v1.7.8 

func (c *Client) LinkDetectorToTeam(ctx context.Context, id string, detectorID string) error

LinkDetectorToTeam links a detector to a team.

func (*Client) SearchAlertMutingRules added in v1.6.8 

func (c *Client) SearchAlertMutingRules(ctx context.Context, include string, limit int, query string, offset int) (*alertmuting.SearchResult, error)

SearchAlertMutingRules searches for alert muting rules given a query string in `name`.

func (*Client) SearchCharts 

func (c *Client) SearchCharts(ctx context.Context, limit int, name string, offset int, tags string) (*chart.SearchResult, error)

SearchCharts searches for charts, given a query string in `name`.

func (*Client) SearchDashboard 

func (c *Client) SearchDashboard(ctx context.Context, limit int, name string, offset int, tags string) (*dashboard.SearchResult, error)

SearchDashboard searches for dashboards, given a query string in `name`.

func (*Client) SearchDashboardGroups 

func (c *Client) SearchDashboardGroups(ctx context.Context, limit int, name string, offset int) (*dashboard_group.SearchResult, error)

SearchDashboardGroup searches for dashboard groups, given a query string in `name`. 

func (c *Client) SearchDataLinks(ctx context.Context, limit int, context string, offset int) (*datalink.SearchResults, error)

SearchDataLinks searches for data links given a query string in `name`.

func (*Client) SearchDetectors 

func (c *Client) SearchDetectors(ctx context.Context, limit int, name string, offset int, tags string) (*detector.SearchResults, error)

SearchDetectors searches for detectors, given a query string in `name`.

func (*Client) SearchDimension 

func (c *Client) SearchDimension(ctx context.Context, query string, orderBy string, limit int, offset int) (*metrics_metadata.DimensionQueryResponseModel, error)

SearchDimension searches for dimensions, given a query string in `query`.

func (*Client) SearchMetric 

func (c *Client) SearchMetric(ctx context.Context, query string, orderBy string, limit int, offset int) (*metrics_metadata.RetrieveMetricMetadataResponseModel, error)

SearchMetric searches for metrics, given a query string in `query`.

func (*Client) SearchMetricTimeSeries 

func (c *Client) SearchMetricTimeSeries(ctx context.Context, query string, orderBy string, limit int, offset int) (*metrics_metadata.MetricTimeSeriesRetrieveResponseModel, error)

SearchMetricTimeSeries searches for metric time series, given a query string in `query`.

func (*Client) SearchOrgTokens added in v1.5.0 

func (c *Client) SearchOrgTokens(ctx context.Context, limit int, name string, offset int) (*orgtoken.SearchResults, error)

SearchOrgTokens searches for tokens given a query string in `name`.

func (*Client) SearchTag 

func (c *Client) SearchTag(ctx context.Context, query string, orderBy string, limit int, offset int) (*metrics_metadata.TagRetrieveResponseModel, error)

SearchTag searches for tags, given a query string in `query`.

func (*Client) SearchTeam 

func (c *Client) SearchTeam(ctx context.Context, limit int, name string, offset int, tags string) (*team.SearchResults, error)

SearchTeam searches for teams, given a query string in `name`.

func (*Client) UnlinkDashboardGroupFromTeam added in v1.7.8 

func (c *Client) UnlinkDashboardGroupFromTeam(ctx context.Context, id string, dashboardGroupID string) error

UnlinkDashboardGroupFromTeam unlinks a dashboard group from a team.

func (*Client) UnlinkDetectorFromTeam added in v1.7.8 

func (c *Client) UnlinkDetectorFromTeam(ctx context.Context, id string, detectorID string) error

UnLinkDetectorFromTeam unlinks a detector from a team.

func (*Client) UpdateAWSCloudWatchIntegration added in v1.3.0 

func (c *Client) UpdateAWSCloudWatchIntegration(ctx context.Context, id string, acwi *integration.AwsCloudWatchIntegration) (*integration.AwsCloudWatchIntegration, error)

UpdateAWSCloudWatchIntegration updates an AWS CloudWatch integration.

func (*Client) UpdateAlertMutingRule added in v1.6.8 

func (c *Client) UpdateAlertMutingRule(ctx context.Context, id string, muteRequest *alertmuting.CreateUpdateAlertMutingRuleRequest) (*alertmuting.AlertMutingRule, error)

UpdateAlertMutingRule updates an alert muting rule.

func (*Client) UpdateAzureIntegration added in v1.4.0 

func (c *Client) UpdateAzureIntegration(ctx context.Context, id string, acwi *integration.AzureIntegration) (*integration.AzureIntegration, error)

UpdateAzureIntegration updates an Azure integration.

func (*Client) UpdateChart 

func (c *Client) UpdateChart(ctx context.Context, id string, chartRequest *chart.CreateUpdateChartRequest) (*chart.Chart, error)

UpdateChart updates a chart.

func (*Client) UpdateDashboard 

func (c *Client) UpdateDashboard(ctx context.Context, id string, dashboardRequest *dashboard.CreateUpdateDashboardRequest) (*dashboard.Dashboard, error)

UpdateDashboard updates a dashboard.

func (*Client) UpdateDashboardGroup 

func (c *Client) UpdateDashboardGroup(ctx context.Context, id string, dashboardGroupRequest *dashboard_group.CreateUpdateDashboardGroupRequest) (*dashboard_group.DashboardGroup, error)

UpdateDashboardGroup updates a dashboard group. 

func (c *Client) UpdateDataLink(ctx context.Context, id string, dataLinkRequest *datalink.CreateUpdateDataLinkRequest) (*datalink.DataLink, error)

UpdateDataLink updates a data link.

func (*Client) UpdateDetector 

func (c *Client) UpdateDetector(ctx context.Context, id string, detectorRequest *detector.CreateUpdateDetectorRequest) (*detector.Detector, error)

UpdateDetector updates a detector.

func (*Client) UpdateDimension 

func (c *Client) UpdateDimension(ctx context.Context, key string, value string, dim *metrics_metadata.Dimension) (*metrics_metadata.Dimension, error)

UpdateDimension updates a dimension.

func (*Client) UpdateGCPIntegration added in v1.6.0 

func (c *Client) UpdateGCPIntegration(ctx context.Context, id string, gcpi *integration.GCPIntegration) (*integration.GCPIntegration, error)

UpdateGCPIntegration updates a GCP integration.

func (*Client) UpdateJiraIntegration added in v1.6.5 

func (c *Client) UpdateJiraIntegration(ctx context.Context, id string, ji *integration.JiraIntegration) (*integration.JiraIntegration, error)

UpdateJiraIntegration updates an Jira integration.

func (*Client) UpdateMember added in v1.31.0 

func (c *Client) UpdateMember(ctx context.Context, id string, updateRequest *organization.UpdateMemberRequest) (*organization.Member, error)

Updates admin status of a member.

func (*Client) UpdateMetricRuleset added in v1.27.0 

func (c *Client) UpdateMetricRuleset(ctx context.Context, id string, metricRuleset *metric_ruleset.UpdateMetricRulesetRequest) (*metric_ruleset.UpdateMetricRulesetResponse, error)

UpdateMetricRuleset updates a metric ruleset.

func (*Client) UpdateOpsgenieIntegration added in v1.6.0 

func (c *Client) UpdateOpsgenieIntegration(ctx context.Context, id string, oi *integration.OpsgenieIntegration) (*integration.OpsgenieIntegration, error)

UpdateOpsgenieIntegration updates an Opsgenie integration.

func (*Client) UpdateOrgToken added in v1.5.0 

func (c *Client) UpdateOrgToken(ctx context.Context, id string, tokenRequest *orgtoken.CreateUpdateTokenRequest) (*orgtoken.Token, error)

UpdateOrgToken updates a token.

func (*Client) UpdatePagerDutyIntegration added in v1.6.0 

func (c *Client) UpdatePagerDutyIntegration(ctx context.Context, id string, pdi *integration.PagerDutyIntegration) (*integration.PagerDutyIntegration, error)

UpdatePagerDutyIntegration updates a PagerDuty integration.

func (*Client) UpdateServiceNowIntegration added in v1.12.0 

func (c *Client) UpdateServiceNowIntegration(ctx context.Context, id string, in *integration.ServiceNowIntegration) (*integration.ServiceNowIntegration, error)

UpdateServiceNowIntegration updates SNOW integration.

func (*Client) UpdateSlackIntegration added in v1.6.0 

func (c *Client) UpdateSlackIntegration(ctx context.Context, id string, si *integration.SlackIntegration) (*integration.SlackIntegration, error)

UpdateSlackIntegration updates a Slack integration.

func (*Client) UpdateSlo added in v1.34.0 

func (c *Client) UpdateSlo(ctx context.Context, id string, sloRequest *slo.SloObject) (*slo.SloObject, error)

func (*Client) UpdateTeam 

func (c *Client) UpdateTeam(ctx context.Context, id string, t *team.CreateUpdateTeamRequest) (*team.Team, error)

UpdateTeam updates a team.

func (*Client) UpdateVictorOpsIntegration added in v1.6.2 

func (c *Client) UpdateVictorOpsIntegration(ctx context.Context, id string, oi *integration.VictorOpsIntegration) (*integration.VictorOpsIntegration, error)

UpdateVictorOpsIntegration updates an VictorOps integration.

func (*Client) UpdateWebhookIntegration added in v1.6.19 

func (c *Client) UpdateWebhookIntegration(ctx context.Context, id string, oi *integration.WebhookIntegration) (*integration.WebhookIntegration, error)

UpdateWebhookIntegration updates an Webhook integration.

func (*Client) ValidateDetector added in v1.8.4 

func (c *Client) ValidateDetector(ctx context.Context, detectorRequest *detector.ValidateDetectorRequestModel) error

ValidateDetector validates a detector.

func (*Client) ValidateSlo added in v1.34.0 

func (c *Client) ValidateSlo(ctx context.Context, sloRequest *slo.SloObject) error

type ClientParam 

type ClientParam func(*Client) error

ClientParam is an option for NewClient. Its implementation borrows from Dave Cheney's functional options API (https://dave.cheney.net/2014/10/17/functional-options-for-friendly-apis).

func APIUrl 

func APIUrl(apiURL string) ClientParam

APIUrl sets the URL that our client will communicate with, allowing it to be adjusted to another URL for testing or communication with other SignalFx clusters. Example `"https://api.signalfx.com"`.

func HTTPClient 

func HTTPClient(httpClient *http.Client) ClientParam

HTTPClient sets the `http.Client` that this API client will use to to communicate. This allows you to replace the client or tune it to your needs.

func UserAgent added in v1.6.32 

func UserAgent(userAgent string) ClientParam

UserAgent sets the UserAgent string to include with the request.

Source Files

View all Source files

Directories

Path Synopsis
package realm contains helpers for constructing realm-specific urls and config.
 package realm contains helpers for constructing realm-specific urls and config.
signalflow module
Package writer contains a set of components that accept a single type of SignalFx data (e.g.
 Package writer contains a set of components that accept a single type of SignalFx data (e.g.
template

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.