Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateUpdateTagRequest ¶
type CreateUpdateTagRequest struct { // A description of the tag. You can use up to 1024 UTF-8 characters. Description string `json:"description,omitempty"` // The custom properties for the tag, in the form of a JSON object (dictionary). Each property is a custom property name and value. The section [Custom Properties Criteria](https://developers.signalfx.com/metrics/metrics_metadata_overview.html#_custom_properties_criteria) lists the requirements for custom property names and values. CustomProperties map[string]string `json:"customProperties,omitempty"` }
The metadata for a single tag: * For a GET request, this is the metadata for an existing tag retrieved from the `/tag` or `/tag/{name}` endpoint * For a PUT request, this is the metadata for the tag specified by the `{name}` path parameter of the `/tag/{name}` endpoint, after the tag has been created or updated.
type Dimension ¶
type Dimension struct { // The dimension name (key) for the dimension. Dimension names have these requirements: <br> * UTF-8 string, maximum length of 128 characters (512 bytes) * Must start with an uppercase or lowercase letter. The rest of the name can contain letters, numbers, underscores (`_`) and hyphens (`-`). * Must not start with the underscore character (`_`) * Must not start with the prefix `sf_`, except for dimensions defined by SignalFx such as `sf_hires` * Must not start with the prefix `aws_` Key string `json:"key,omitempty"` // The dimension value for the dimension. Dimension values have these requirements: <br> * String: Maximum length 256 UTF-8 characters (1024 bytes) * Integer or float: Maximum length 8192 bits (1024 bytes) Value string `json:"value,omitempty"` // The description for the dimension. You can use up to 1024 UTF-8 characters. Description string `json:"description,omitempty"` // The custom properties for the dimension, in the form of a JSON object (dictionary) containing custom property key-value pairs. Custom property names and values have these requirements: <br> **Name:** <br> * UTF-8 string, maximum length of 128 characters (512 bytes) * Must start with an uppercase or lowercase letter. The rest of the name can contain letters, numbers, underscores (`_`) and hyphens (`-`). * Must not start with the underscore character (`_`) <br> **Value:** <br> * String: Maximum length 256 UTF-8 characters (1024 bytes) * Integer or float: Maximum length 8192 bits (1024 bytes) CustomProperties map[string]string `json:"customProperties,omitempty"` // The tags for the dimension, in the form of an array that contains one string for each tag. <br> Each tag is a UTF-8 string, starting with an uppercase or lowercase alphabetic character. The maximum length is expressed in characters; if a string consists solely of single-byte UTF-8 entities, 1024 characters are available. <br> **NOTE:** You can't have more than 50 tags per MTS Tags []string `json:"tags,omitempty"` // The SignalFx user ID of the user that created the dimension. Creator string `json:"creator,omitempty"` // Dimension creation timestamp, in Unix time UTC-relative Created int64 `json:"created,omitempty"` // The SignalFx user ID of the user that last updated the dimension. LastUpdatedBy string `json:"lastUpdatedBy,omitempty"` // Last updated timestamp, in Unix time UTC-relative LastUpdated int64 `json:"lastUpdated,omitempty"` }
A JSON object (dictionary) that contains the metadata for a single dimension that matched the query
type DimensionKeyValueModel ¶
type DimensionKeyValueModel struct { // A dimension name (key) for an existing dimension: * For a GET response, this value is the dimension name retrieved by the request. * For a PUT request, this value is the dimension you want to update. The PUT response echoes the request body. The section [Dimension Criteria](https://developers.signalfx.com/metrics/metrics_metadata_overview.html#_dimension_criteria) lists the requirements for dimensions. Key string `json:"key,omitempty"` // A dimension value for an existing dimension. Value map[string]interface{} `json:"value,omitempty"` // The description for the dimension. You can use up to 1024 UTF-8 characters. Description string `json:"description,omitempty"` // The custom properties for the dimension, in the form of a JSON object (dictionary) containing custom property key-value pairs: <br> * For a GET response, this value contains the existing custom properties. * For a PUT *request*, use this property to update custom properties for the dimension. The PUT *response* returns all of the custom properties for the specified dimension. The section [Custom Properties Criteria](https://developers.signalfx.com/metrics/metrics_metadata_overview.html#_custom_properties_criteria) lists the requirements for custom properties. CustomProperties map[string]string `json:"customProperties,omitempty"` // The tags for the dimension: * For a GET response, this value contains the tags. * For a PUT request, use this property to update tags for the dimension. The PUT response returns all of the tags for the specified dimension. The section [Tags Criteria](https://developers.signalfx.com/metrics/metrics_metadata_overview.html#_tags_criteria) lists the requirements for tags. Tags []string `json:"tags,omitempty"` // A SignalFx user ID:<br> * For a GET request: The user that created the dimension. * For a PUT request, the ID of the user that's making the request; the response echoes the request value. Creator string `json:"creator,omitempty"` // Creation timestamp, in Unix time UTC-relative:<br> * For a GET request: time when the dimension was first created * For a PUT request: timestamp to set as the creation time; the response echoes the request value. Created int64 `json:"created,omitempty"` // A SignalFx user ID:<br> * For a GET request: The user that last updated the dimension. * For a PUT request, the ID of the user that's making the request; the response echoes the request value. LastUpdatedBy string `json:"lastUpdatedBy,omitempty"` // Last updated timestamp, in Unix time UTC-relative:<br> * For a GET request: time when the dimension was updated * For a PUT request: timestamp to set as the update time; the response echoes the request value. LastUpdated int64 `json:"lastUpdated,omitempty"` }
The request and response body for the GET or PUT methods of the `/dimension/{key}/{value}` endpoint.
type DimensionQueryResponseModel ¶
type DimensionQueryResponseModel struct { // An array of JSON objects (dictionaries). Each object contains metadata for one dimension that matched the query. Results []*Dimension `json:"results,omitempty"` // The number of objects the API returned. This is the same as the size of the `results` property array. Count int32 `json:"count,omitempty"` }
The response body for the GET method of the `/dimension` endpoint.
type Metric ¶
type Metric struct { // Name of the metric that has the retrieved metadata Name string `json:"name,omitempty"` // Description of the metric that has the retrieved metadata. You can use up to 1024 UTF-8 characters. Description string `json:"description,omitempty"` // Metric type of the metric that has the retrieved metadata. The possible values are \"GAUGE\", \"COUNTER\", and \"CUMULATIVE_COUNTER\". Type string `json:"type,omitempty"` // Dimension metadata for the result object, in the form of a JSON object (dictionary). Each property is a dimension name and dimension value. Dimension names and values have these requirements: <br> **Name:** * UTF-8 string, maximum length of 128 characters (512 bytes) * Must start with an uppercase or lowercase letter. The rest of the name can contain letters, numbers, underscores (`_`) and hyphens (`-`). * Must not start with the underscore character (`_`) * Must not start with the prefix `sf_`, except for dimensions defined by SignalFx such as `sf_hires` * Must not start with the prefix `aws_` <br> **Value:** * String: Maximum length 256 UTF-8 characters (1024 bytes) * Integer or float: Maximum length 8192 bits (1024 bytes) Dimensions map[string]interface{} `json:"dimensions,omitempty"` // Custom property metadata for the result object, in the form of a JSON object (dictionary). Each property is a custom property name and value. Custom property names and values have these requirements <br> **Name:** * UTF-8 string, maximum length of 128 characters (512 bytes) * Must start with an uppercase or lowercase letter. The rest of the name can contain letters, numbers, underscores (`_`) and hyphens (`-`). * Must not start with the underscore character (`_`) <br> **Value:** * String: Maximum length 256 UTF-8 characters (1024 bytes) * Integer or float: Maximum length 8192 bits (1024 bytes) CustomProperties map[string]string `json:"customProperties,omitempty"` // Tag metadata in the response, in the form of a JSON array (a list) with one element for each tag. Each tag is a UTF-8 string, starting with an uppercase or lowercase alphabetic character. The maximum length is expressed in characters; if a string consists solely of single-byte UTF-8 entities, 1024 characters are available. <br> Tags []string `json:"tags,omitempty"` // The time that the metric was created, in Unix time UTC-relative Created int64 `json:"created,omitempty"` // SignalFx ID of the user who created the metric. If the value is \"AAAAAAAAAAA\", SignalFx created the metric. Creator string `json:"creator,omitempty"` // The time that the metric was last updated, in Unix time UTC-relative LastUpdated int64 `json:"lastUpdated,omitempty"` // SignalFx ID of the user who last updated the metric. If the value is \"AAAAAAAAAAA\", SignalFx last updated the metric. LastUpdatedBy string `json:"lastUpdatedBy,omitempty"` }
Metadata for an individual result of the metrics metadata query
type MetricTimeSeries ¶
type MetricTimeSeries struct { // Name of the MTS. Metric names are UTF-8 strings with a maximum length of 256 characters (1024 bytes). Metric string `json:"metric,omitempty"` // Metric type of the MTS for this metadata. The possible values are \"GAUGE\", \"COUNTER\", and \"CUMULATIVE_COUNTER\". Type string `json:"type,omitempty"` // Dimension metadata for the MTS, in the form of a JSON object (dictionary). Each property is a dimension name and dimension value. The section [Dimension Criteria](https://developers.signalfx.com/metrics/metrics_metadata_overview.html#_dimension_criteria) lists the requirements for dimensions. Dimensions map[string]interface{} `json:"dimensions,omitempty"` // Custom property metadata for the MTS, in the form of a JSON object (dictionary). Each property is a custom property name and value. The section [Custom Properties Criteria](https://developers.signalfx.com/metrics/metrics_metadata_overview.html#_custom_properties_criteria) lists the requirements for custom properties. Custom property metadata for the MTS, in the form of a JSON object (dictionary). Each property is a custom property name and value. Custom property names and values have these criteria: <br> **Name:** <br> * UTF-8 string, maximum length of 128 characters (512 bytes) * Must start with an uppercase or lowercase letter. The rest of the name can contain letters, numbers, underscores (`_`) and hyphens (`-`). * Must not start with the underscore character (`_`) <br> **Value:** * String: Maximum length 256 UTF-8 characters (1024 bytes) * Integer or float: Maximum length 8192 bits (1024 bytes) CustomProperties map[string]string `json:"customProperties,omitempty"` // Tag metadata for the MTS, in the form of a JSON array (a list) with one element for each tag. <br> Each tag is a UTF-8 string, starting with an uppercase or lowercase alphabetic character. The maximum length is expressed in characters; if a string consists solely of single-byte UTF-8 entities, 1024 characters are available. Tags []string `json:"tags,omitempty"` // The time that the MTS was created, in Unix time UTC-relative Created int64 `json:"created,omitempty"` // SignalFx ID of the user who created the MTS. If the value is \"AAAAAAAAAAA\", SignalFx created the MTS. Creator string `json:"creator,omitempty"` // The time that the MTS was last updated, in Unix time UTC-relative LastUpdated int64 `json:"lastUpdated,omitempty"` // SignalFx ID of the user who last updated the MTS. If the value is \"AAAAAAAAAAA\", SignalFx last updated the metric. LastUpdatedBy string `json:"lastUpdatedBy,omitempty"` }
The metadata for a single retrieved metric timeseries
type MetricTimeSeriesRetrieveResponseModel ¶
type MetricTimeSeriesRetrieveResponseModel struct { // An array of JSON objects (dictionaries). Each object contains the metadata for one MTS that matched the query. Results []MetricTimeSeries `json:"results,omitempty"` // The number of objects the API returned. This is the same as the size of the `results` property array. Count int32 `json:"count,omitempty"` }
JSON returned by the GET method of the `/metrictimeseries` endpoint
type RetrieveMetricMetadataResponseModel ¶
type RetrieveMetricMetadataResponseModel struct { // An array of metrics metadata results Result []*Metric `json:"result,omitempty"` // Number of result objects returned. This value is the same as the size of the `result` value array. Count int32 `json:"count,omitempty"` }
The results of the metrics metadata request
type Tag ¶
type Tag struct { // The tag. Tags are in UTF-8 format. The section [Tags Criteria](https://developers.signalfx.com/metrics/metrics_metadata_overview.html#_tags_criteria) lists the requirements for tags. Name string `json:"name,omitempty"` // A description of the tag. You can use up to 1024 UTF-8 characters. Description string `json:"description,omitempty"` // The custom properties for the tag, in the form of a JSON object (dictionary). Each property is a custom property name and value. The section [Custom Properties Criteria](https://developers.signalfx.com/metrics/metrics_metadata_overview.html#_custom_properties_criteria) lists the requirements for custom property names and values. CustomProperties map[string]string `json:"customProperties,omitempty"` // The time that the tag was created, in Unix time UTC-relative. Created int64 `json:"created,omitempty"` // SignalFx ID of the user who created the tag. If the value is \"AAAAAAAAAAA\", SignalFx created the tag. Creator string `json:"creator,omitempty"` // The time that the tag was last updated, in Unix time UTC-relative LastUpdated int64 `json:"lastUpdated,omitempty"` // SignalFx ID of the user who last updated the tag. If the value is \"AAAAAAAAAAA\", SignalFx last updated the metric. LastUpdatedBy string `json:"lastUpdatedBy,omitempty"` }
The metadata for a single tag: * For a GET request, this is the metadata for an existing tag retrieved from the `/tag` or `/tag/{name}` endpoint * For a PUT request, this is the metadata for the tag specified by the `{name}` path parameter of the `/tag/{name}` endpoint, after the tag has been created or updated.
type TagRetrieveResponseModel ¶
type TagRetrieveResponseModel struct { // An array of JSON objects (dictionaries). Each object contains the metadata for one tag that matched the query. Results []*Tag `json:"results,omitempty"` // The number of objects the API returned. This is the same as the size of the `results` property array. Count int32 `json:"count,omitempty"` }
JSON returned by the GET method of the `/tag` endpoint
Source Files ¶
- model_create_update_tag_request.go
- model_dimension.go
- model_dimension_key_value_model.go
- model_dimension_query_response_model.go
- model_metric.go
- model_metric_time_series.go
- model_metric_time_series_retrieve_response_model.go
- model_retrieve_metric_metadata_response_model.go
- model_tag.go
- model_tag_retrieve_response_model.go