overview
Creates, updates, deletes, gets or lists an overview resource.
Overview​
| Name | overview |
| Type | Resource |
| Id | sumologic.collectors.overview |
Fields​
The following fields are returned by SELECT queries:
- get
| Name | Datatype | Description |
|---|---|---|
errors | integer | |
hosted_collectors_count | integer | (wire: hostedCollectorsCount) |
hosted_sources_count | integer | (wire: hostedSourcesCount) |
installed_collectors_count | integer | (wire: installedCollectorsCount) |
installed_sources_count | integer | (wire: installedSourcesCount) |
offline_collectors_count | integer | (wire: offlineCollectorsCount) |
warnings | integer |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | region | Summary counts of Installed and Hosted Collectors and Sources, offline Collectors, errors and warnings. |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | Sumo Logic deployment (au, ca, ch, de, eu, fed, in, jp, kr, us1, us2). Resolved from the SUMOLOGIC_ENVIRONMENT environment variable when it is set (x-stackQL-envVar, the same variable the Terraform provider reads); otherwise defaults to us2. A WHERE region = '...' value always takes precedence. (enum: [au, ca, ch, de, eu, fed, in, jp, kr, us1, us2], default: us2, x-stackQL-envVar: SUMOLOGIC_ENVIRONMENT) |
SELECT examples​
- get
Summary counts of Installed and Hosted Collectors and Sources, offline Collectors, errors and warnings.
SELECT
errors,
hosted_collectors_count,
hosted_sources_count,
installed_collectors_count,
installed_sources_count,
offline_collectors_count,
warnings
FROM sumologic.collectors.overview
WHERE region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;