diff --git a/docs/data-sources/functions.md b/docs/data-sources/functions.md index c43f769..e8298e9 100644 --- a/docs/data-sources/functions.md +++ b/docs/data-sources/functions.md @@ -17,14 +17,23 @@ Guance Cloud Function is a function development, management and execution platfo ### Optional +- `filter` (Attributes List) The list of the resource (see [below for nested schema](#nestedatt--filter)) - `max_results` (Number) The max results count of the resource will be returned. -- `type_name` (String) The type name of the resource be queried ### Read-Only - `id` (String) Identifier of the resource. - `items` (Attributes List) The list of the resource (see [below for nested schema](#nestedatt--items)) + +### Nested Schema for `filter` + +Required: + +- `name` (String) The filter path, represent as json path. +- `values` (List of String) The filter values + + ### Nested Schema for `items` @@ -34,4 +43,9 @@ Optional: - `func_id` (String) Function ID - `title` (String) Title +Read-Only: + +- `created_at` (String) Timestamp of the last Terraform update of the order. +- `id` (String) Numeric identifier of the order. + diff --git a/docs/resources/member.md b/docs/data-sources/members.md similarity index 62% rename from docs/resources/member.md rename to docs/data-sources/members.md index f00711b..4340556 100644 --- a/docs/resources/member.md +++ b/docs/data-sources/members.md @@ -1,6 +1,6 @@ --- # generated by https://github.com/hashicorp/terraform-plugin-docs -page_title: "guance_member Resource - guance" +page_title: "guance_members Data Source - guance" subcategory: "" description: |- A workspace member is a user who has access to a workspace. @@ -11,7 +11,7 @@ description: |- A[Workspace] --> B[Member] --- -# guance_member (Resource) +# guance_members (Data Source) A workspace member is a user who has access to a workspace. @@ -29,19 +29,34 @@ graph LR ## Schema -### Required +### Optional -- `workspace_id` (String) Workspace ID +- `filter` (Attributes List) The list of the resource (see [below for nested schema](#nestedatt--filter)) +- `max_results` (Number) The max results count of the resource will be returned. -### Optional +### Read-Only + +- `id` (String) Identifier of the resource. +- `items` (Attributes List) The list of the resource (see [below for nested schema](#nestedatt--items)) + + +### Nested Schema for `filter` + +Required: + +- `name` (String) The filter path, represent as json path. +- `values` (List of String) The filter values + + + +### Nested Schema for `items` + +Optional: - `email` (String) Email -- `mobile` (String) Mobile -- `name` (String) Name - `role` (String) Role -- `username` (String) Username -### Read-Only +Read-Only: - `created_at` (String) Timestamp of the last Terraform update of the order. - `id` (String) Numeric identifier of the order. diff --git a/docs/data-sources/resourceschemas.md b/docs/data-sources/resourceschemas.md deleted file mode 100644 index ab7f24c..0000000 --- a/docs/data-sources/resourceschemas.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -# generated by https://github.com/hashicorp/terraform-plugin-docs -page_title: "guance_resourceschemas Data Source - guance" -subcategory: "" -description: |- - Resource Schema is the core of semantic API. You can discover all the resource by resource schema. - The typically usage is: - If you are the third-party vendor, you can create your integration page by schemaIf you need the SDK we haven't published, you can create your own SDK by resource schema - mermaid - graph LR - Registry -- fetch schema --> Script - Script -- generate --> SDK ---- - -# guance_resourceschemas (Data Source) - -Resource Schema is the core of semantic API. You can discover all the resource by resource schema. - -The typically usage is: - -* If you are the third-party vendor, you can create your integration page by schema -* If you need the SDK we haven't published, you can create your own SDK by resource schema - -```mermaid -graph LR - Registry -- fetch schema --> Script - Script -- generate --> SDK -``` - - - - -## Schema - -### Optional - -- `max_results` (Number) The max results count of the resource will be returned. -- `type_name` (String) The type name of the resource be queried - -### Read-Only - -- `id` (String) Identifier of the resource. -- `items` (Attributes List) The list of the resource (see [below for nested schema](#nestedatt--items)) - - -### Nested Schema for `items` - -Required: - -- `name` (String) Resource name - -Optional: - -- `description` (Attributes) Resource description (see [below for nested schema](#nestedatt--items--description)) -- `models` (Attributes List) Resource dependends on model (see [below for nested schema](#nestedatt--items--models)) -- `title` (Attributes) Resource title (see [below for nested schema](#nestedatt--items--title)) - - -### Nested Schema for `items.description` - -Optional: - -- `en` (String) English -- `zh` (String) Chinese - - - -### Nested Schema for `items.models` - -Required: - -- `name` (String) Model name - -Optional: - -- `description` (Attributes) Model description (see [below for nested schema](#nestedatt--items--models--description)) -- `properties` (Attributes List) Model properties (see [below for nested schema](#nestedatt--items--models--properties)) -- `title` (Attributes) Model title (see [below for nested schema](#nestedatt--items--models--title)) - - -### Nested Schema for `items.models.description` - -Optional: - -- `en` (String) English -- `zh` (String) Chinese - - - -### Nested Schema for `items.models.properties` - -Required: - -- `name` (String) Property name - -Optional: - -- `description` (Attributes) Property description (see [below for nested schema](#nestedatt--items--models--properties--description)) -- `meta` (Attributes) Property meta (see [below for nested schema](#nestedatt--items--models--properties--meta)) -- `schema` (Attributes) Property schema (see [below for nested schema](#nestedatt--items--models--properties--schema)) -- `title` (Attributes) Property title (see [below for nested schema](#nestedatt--items--models--properties--title)) - - -### Nested Schema for `items.models.properties.title` - -Optional: - -- `en` (String) English -- `zh` (String) Chinese - - - -### Nested Schema for `items.models.properties.title` - -Optional: - -- `dynamic` (Boolean) Property is dynamic -- `immutable` (Boolean) Property is immutable - - - -### Nested Schema for `items.models.properties.title` - -Required: - -- `type` (String) Property type - -Optional: - -- `elem` (Attributes) Property element schema (see [below for nested schema](#nestedatt--items--models--properties--title--elem)) -- `enum` (Attributes List) Property enum (see [below for nested schema](#nestedatt--items--models--properties--title--enum)) -- `format` (String) Property format -- `model` (String) Property reference model -- `ref` (String) Property reference resource -- `required` (Boolean) Property is required - - -### Nested Schema for `items.models.properties.title.elem` - -Required: - -- `type` (String) Element type - -Optional: - -- `enum` (Attributes List) Element enum (see [below for nested schema](#nestedatt--items--models--properties--title--elem--enum)) -- `format` (String) Element format -- `ref` (String) Element reference model - - -### Nested Schema for `items.models.properties.title.elem.ref` - -Required: - -- `name` (String) Enum name -- `value` (String) Enum value - -Optional: - -- `title` (Attributes) Enum title (see [below for nested schema](#nestedatt--items--models--properties--title--elem--ref--title)) - - -### Nested Schema for `items.models.properties.title.elem.ref.title` - -Optional: - -- `en` (String) English -- `zh` (String) Chinese - - - - - -### Nested Schema for `items.models.properties.title.enum` - -Required: - -- `name` (String) Enum name -- `value` (String) Enum value - -Optional: - -- `title` (Attributes) Enum title (see [below for nested schema](#nestedatt--items--models--properties--title--enum--title)) - - -### Nested Schema for `items.models.properties.title.enum.title` - -Optional: - -- `en` (String) English -- `zh` (String) Chinese - - - - - -### Nested Schema for `items.models.properties.title` - -Optional: - -- `en` (String) English -- `zh` (String) Chinese - - - - -### Nested Schema for `items.models.title` - -Optional: - -- `en` (String) English -- `zh` (String) Chinese - - - - -### Nested Schema for `items.title` - -Optional: - -- `en` (String) English -- `zh` (String) Chinese - - diff --git a/docs/index.md b/docs/index.md index 150355f..97a0df3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -17,4 +17,5 @@ Interact with Guance Cloud. ### Optional -- `endpoint` (String) URI for Guance Cloud API. May also be provided via GUANCE_ENDPOINT environment variable. +- `region` (String) Region for Guance Cloud API. May also be provided via GUANCE_REGION environment variable. +- `token` (String, Sensitive) Access token for Guance Cloud API. May also be provided via GUANCE_TOKEN environment variable. diff --git a/docs/resources/alertpolicy.md b/docs/resources/alertpolicy.md index f338db5..b57058f 100644 --- a/docs/resources/alertpolicy.md +++ b/docs/resources/alertpolicy.md @@ -41,37 +41,43 @@ Notes: ### Required - `name` (String) Alert Policy Name +- `statuses` (List of String) The status value of the event to be sent ### Optional -- `alert_target` (Attributes List) Alert Action (see [below for nested schema](#nestedatt--alert_target)) +- `alert_targets` (Attributes List) Alert Action (see [below for nested schema](#nestedatt--alert_targets)) - `silent_timeout` (Number) Silent timeout timestamp -- `type` (String) Trigger rule type, default is custom ### Read-Only - `created_at` (String) Timestamp of the last Terraform update of the order. - `id` (String) Numeric identifier of the order. - -### Nested Schema for `alert_target` + +### Nested Schema for `alert_targets` Required: -- `status` (List of String) The status value of the event to be sent - `type` (String) Alert type Optional: -- `allow_week_days` (List of Number) Allowed to send alerts on weekdays -- `min_interval` (Number) The minimum alert interval, in seconds. 0 / null means always send an alert -- `notification` (Attributes) Notification (see [below for nested schema](#nestedatt--alert_target--notification)) +- `member_group` (Attributes) Member Group (see [below for nested schema](#nestedatt--alert_targets--member_group)) +- `notification` (Attributes) Notification (see [below for nested schema](#nestedatt--alert_targets--notification)) - -### Nested Schema for `alert_target.notification` + +### Nested Schema for `alert_targets.member_group` Required: -- `to` (List of String) Notification +- `id` (String) Member Group + + + +### Nested Schema for `alert_targets.notification` + +Required: + +- `id` (String) Notification diff --git a/docs/resources/dashboard.md b/docs/resources/dashboard.md index a897809..a997dc3 100644 --- a/docs/resources/dashboard.md +++ b/docs/resources/dashboard.md @@ -3,6 +3,7 @@ page_title: "guance_dashboard Resource - guance" subcategory: "" description: |- + WORKING IN PROGRESS! A dashboard is a collection of visualizations that you can use to monitor the health of your systems and applications. Dashboards are made up of one or more panels, which are the visualizations themselves. Each panel displays a single metric or a single aggregation of metrics. Dashboards are a great way to visualize your data and monitor your systems. You can use them to track metrics over time, and to quickly see how your systems are performing. You can also use them to compare metrics from different systems and applications. Guance Cloud's dashboard is used to clearly show the range in which the metric data values are located. It is suitable for slicing messy data into points. @@ -10,6 +11,8 @@ description: |- # guance_dashboard (Resource) +**WORKING IN PROGRESS!** + A dashboard is a collection of visualizations that you can use to monitor the health of your systems and applications. Dashboards are made up of one or more panels, which are the visualizations themselves. Each panel displays a single metric or a single aggregation of metrics. Dashboards are a great way to visualize your data and monitor your systems. You can use them to track metrics over time, and to quickly see how your systems are performing. You can also use them to compare metrics from different systems and applications. diff --git a/docs/resources/intelligentinspection.md b/docs/resources/intelligentinspection.md deleted file mode 100644 index a0a1ee2..0000000 --- a/docs/resources/intelligentinspection.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -# generated by https://github.com/hashicorp/terraform-plugin-docs -page_title: "guance_intelligentinspection Resource - guance" -subcategory: "" -description: |- - Intelligent inspection is a feature that allows you to automatically detect abnormality in the system and trigger alarms. It is based on the concept of anomaly detection, which is a time series analysis technique that can detect anomalies in the system based on historical data. - Guance Cloud supports custom intelligent inspection through Function. Based on intelligent algorithms, it automatically detects infrastructure and application problems to help users find problems that have already occurred and potential problems in the process of IT system operation. Through root cause analysis, it can quickly locate the cause of abnormal problems. - Relationships: - mermaid - graph LR - A[Intelligent Inspection] --> B[Function] ---- - -# guance_intelligentinspection (Resource) - -Intelligent inspection is a feature that allows you to automatically detect abnormality in the system and trigger alarms. It is based on the concept of anomaly detection, which is a time series analysis technique that can detect anomalies in the system based on historical data. - -Guance Cloud supports custom intelligent inspection through Function. Based on intelligent algorithms, it automatically detects infrastructure and application problems to help users find problems that have already occurred and potential problems in the process of IT system operation. Through root cause analysis, it can quickly locate the cause of abnormal problems. - -Relationships: - -```mermaid -graph LR - A[Intelligent Inspection] --> B[Function] -``` - - - - -## Schema - -### Optional - -- `monitor_id` (String) Monitor ID -- `ref_func` (Attributes) Ref Func Info (see [below for nested schema](#nestedatt--ref_func)) -- `ref_key` (String) Ref Key - -### Read-Only - -- `created_at` (String) Timestamp of the last Terraform update of the order. -- `id` (String) Numeric identifier of the order. - - -### Nested Schema for `ref_func` - -Optional: - -- `args` (List of String) Args -- `category` (String) Category -- `definition` (String) Definition -- `description` (String) Description -- `disabled` (Boolean) Is Disabled -- `func_id` (String) Func ID -- `kwargs` (String) Kwargs -- `title` (String) Title - - diff --git a/docs/resources/membergroup.md b/docs/resources/membergroup.md new file mode 100644 index 0000000..e9b7ff3 --- /dev/null +++ b/docs/resources/membergroup.md @@ -0,0 +1,49 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "guance_membergroup Resource - guance" +subcategory: "" +description: |- + Member group is a collection of members in a workspace, and member groups can be authorized to access the resources in the workspace. + Member group is an abstract concept, it can be a team, or a department, it can help us build a reasonable organizational structure, optimize the management efficiency and user experience of the observability platform. + Relationships: + ```mermaid + graph LR + A[Workspace] --> B[Member] + A --> C[MemberGroup] + ``` +--- + +# guance_membergroup (Resource) + +Member group is a collection of members in a workspace, and member groups can be authorized to access the resources in the workspace. + +Member group is an abstract concept, it can be a team, or a department, it can help us build a reasonable organizational structure, optimize the management efficiency and user experience of the observability platform. + +Relationships: + +```mermaid +graph LR + +A[Workspace] --> B[Member] +A --> C[MemberGroup] +``` + + + + +## Schema + +### Required + +- `name` (String) Name + +### Optional + +- `member_ids` (List of String) Member id list + +### Read-Only + +- `created_at` (String) Timestamp of the last Terraform update of the order. +- `id` (String) Numeric identifier of the order. + + diff --git a/docs/resources/monitor.md b/docs/resources/monitor.md index 90e8431..be16a39 100644 --- a/docs/resources/monitor.md +++ b/docs/resources/monitor.md @@ -3,6 +3,7 @@ page_title: "guance_monitor Resource - guance" subcategory: "" description: |- + WORKING IN PROGRESS! A monitor is a set of checks that you can run against your data. A monitor watches your data over time and alerts you when certain conditions are met. For example, you can create a monitor that watches the average response time of your website and alerts you when the response time is greater than 1 second. Monitors are made up of one or more checks. A check is a single test that you can run against your data. For example, you can create a check that watches the average response time of your website. You can also create a check that watches the percentage of 5xx errors in your logs. Guance Cloud supports defining monitors, users can customize the configuration of detection rules and trigger conditions, and open the monitors to receive related alarm events triggered by the detection rules. @@ -15,6 +16,8 @@ description: |- # guance_monitor (Resource) +**WORKING IN PROGRESS!** + A monitor is a set of checks that you can run against your data. A monitor watches your data over time and alerts you when certain conditions are met. For example, you can create a monitor that watches the average response time of your website and alerts you when the response time is greater than 1 second. Monitors are made up of one or more checks. A check is a single test that you can run against your data. For example, you can create a check that watches the average response time of your website. You can also create a check that watches the percentage of 5xx errors in your logs. diff --git a/docs/resources/mute.md b/docs/resources/mute.md index c808d44..9de2586 100644 --- a/docs/resources/mute.md +++ b/docs/resources/mute.md @@ -31,35 +31,91 @@ graph LR ### Optional -- `end` (Number) End -- `mute_ranges` (List of String) Mute Ranges +- `mute_ranges` (Attributes List) Mute Ranges (see [below for nested schema](#nestedatt--mute_ranges)) - `notify` (Attributes) Notify Options (see [below for nested schema](#nestedatt--notify)) +- `notify_targets` (Attributes List) Notify targets (see [below for nested schema](#nestedatt--notify_targets)) +- `onetime` (Attributes) Onetime (see [below for nested schema](#nestedatt--onetime)) - `repeat` (Attributes) Repeat (see [below for nested schema](#nestedatt--repeat)) -- `start` (Number) Start -- `tags` (Attributes) Tags (see [below for nested schema](#nestedatt--tags)) ### Read-Only - `created_at` (String) Timestamp of the last Terraform update of the order. - `id` (String) Numeric identifier of the order. + +### Nested Schema for `mute_ranges` + +Required: + +- `type` (String) Mute Range Type + +Optional: + +- `alert_policy` (Attributes) Alert Policy configuration (see [below for nested schema](#nestedatt--mute_ranges--alert_policy)) +- `monitor` (Attributes) Monitor configuration (see [below for nested schema](#nestedatt--mute_ranges--monitor)) + + +### Nested Schema for `mute_ranges.alert_policy` + +Required: + +- `id` (String) Alert Policy ID + + + +### Nested Schema for `mute_ranges.monitor` + +Required: + +- `id` (String) Monitor ID + + + ### Nested Schema for `notify` Optional: +- `before_time` (String) Notify Time - `message` (String) Notify Message -- `targets` (Attributes List) Notify Targets (see [below for nested schema](#nestedatt--notify--targets)) -- `time` (Number) Notify Time - -### Nested Schema for `notify.targets` + + +### Nested Schema for `notify_targets` Required: -- `to` (String) Notify Target - `type` (String) Notify Type +Optional: + +- `member_group` (Attributes) MemberGroup (see [below for nested schema](#nestedatt--notify_targets--member_group)) +- `notification` (Attributes) Notification (see [below for nested schema](#nestedatt--notify_targets--notification)) + + +### Nested Schema for `notify_targets.member_group` + +Required: + +- `id` (String) MemberGroup ID + + + +### Nested Schema for `notify_targets.notification` + +Required: + +- `id` (String) Notification ID + + + + +### Nested Schema for `onetime` + +Optional: + +- `end` (String) End +- `start` (String) Start @@ -68,9 +124,10 @@ Required: Optional: - `crontab` (Attributes) Repeat Crontab Set (see [below for nested schema](#nestedatt--repeat--crontab)) -- `crontab_duration` (Number) Crontab Duration -- `expire` (Number) Repeat Expire -- `time` (Number) Repeat Time Set +- `crontab_duration` (String) Crontab Duration +- `end` (String) End +- `expire` (String) Repeat Expire +- `start` (String) Start ### Nested Schema for `repeat.crontab` @@ -84,13 +141,3 @@ Optional: - `week` (String) Week - - -### Nested Schema for `tags` - -Required: - -- `key` (String) -- `value` (String) - - diff --git a/docs/resources/pipeline.md b/docs/resources/pipeline.md new file mode 100644 index 0000000..dea4908 --- /dev/null +++ b/docs/resources/pipeline.md @@ -0,0 +1,42 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "guance_pipeline Resource - guance" +subcategory: "" +description: |- + Pipeline is a data processing language that Observability Cloud provides. Pipeline supports text parsing of different formats of log data. + By writing a pipeline script, you can customize the structure of the log and use the cut fields as attributes. + By cutting out the attribute fields, we can quickly filter the relevant logs and perform data association analysis to help us quickly locate and solve problems. +--- + +# guance_pipeline (Resource) + +Pipeline is a data processing language that Observability Cloud provides. Pipeline supports text parsing of different formats of log data. + +By writing a pipeline script, you can customize the structure of the log and use the cut fields as attributes. + +By cutting out the attribute fields, we can quickly filter the relevant logs and perform data association analysis to help us quickly locate and solve problems. + + + + +## Schema + +### Required + +- `category` (String) Category +- `content` (String) Pipeline file content +- `name` (String) Name + +### Optional + +- `is_default` (Boolean) Is Default Pipeline +- `is_force` (Boolean) Is Force Overwrite +- `source` (List of String) Data source list +- `test_data` (String) Test data + +### Read-Only + +- `created_at` (String) Timestamp of the last Terraform update of the order. +- `id` (String) Numeric identifier of the order. + + diff --git a/docs/resources/workspace.md b/docs/resources/workspace.md deleted file mode 100644 index e68f9c8..0000000 --- a/docs/resources/workspace.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -# generated by https://github.com/hashicorp/terraform-plugin-docs -page_title: "guance_workspace Resource - guance" -subcategory: "" -description: |- - Workspace is a logical unit that contains all the resources of the Observability system. It is used to isolate the resources of different users and different projects. The resources of the same workspace can be shared with each other, and the resources of different workspaces cannot be shared. - Users can join one or more workspaces by creating or inviting. In the workspace, users can use the observability services provided by the Guance Cloud. - Notes: - The billing method of the workspace only supports changing once a month. ---- - -# guance_workspace (Resource) - -Workspace is a logical unit that contains all the resources of the Observability system. It is used to isolate the resources of different users and different projects. The resources of the same workspace can be shared with each other, and the resources of different workspaces cannot be shared. - -Users can join one or more workspaces by creating or inviting. In the workspace, users can use the observability services provided by the Guance Cloud. - -Notes: - -1. The billing method of the workspace only supports changing once a month. - - - - -## Schema - -### Required - -- `name` (String) Workspace name - -### Optional - -- `description` (String) Workspace description information - -### Read-Only - -- `created_at` (String) Timestamp of the last Terraform update of the order. -- `id` (String) Numeric identifier of the order. - -