From faee4d2dafe584e6c7b8d2d4ae6fe77c2db3af27 Mon Sep 17 00:00:00 2001 From: Kim Pohas Date: Thu, 10 Sep 2026 15:39:35 -0700 Subject: [PATCH 1/4] DOCS-1880 - Remove the fabricated SDK example from the developer release note template The #### SDK Updates section carried an invented worked example: a "Python SDK Version 2.0" release with a made-up pip install sumologic-sdk==2.0.0 command and a link to /docs/api/python-client, a page that does not exist. Remove the example. The section heading and its generic guidance bullets stay; whether the SDK section should exist at all is pending the DOCS-1881 SME decision. Co-Authored-By: Claude Sonnet 5 --- .claude/commands/release-note-developer.md | 30 +--------------------- 1 file changed, 1 insertion(+), 29 deletions(-) diff --git a/.claude/commands/release-note-developer.md b/.claude/commands/release-note-developer.md index 8b11cce1d06..91e4d44bf2c 100644 --- a/.claude/commands/release-note-developer.md +++ b/.claude/commands/release-note-developer.md @@ -190,35 +190,7 @@ For SDK releases: * Version number * What's new or changed * Installation instructions -* Link to SDK docs or GitHub - -**Example:** -```markdown ---- -title: March 23, 2026 - Python SDK Version 2.0 -image: https://assets-www.sumologic.com/company-logos/_800x418_crop_center-center_82_none/SumoLogic_Preview_600x600.jpg?mtime=1617040082 -hide_table_of_contents: true -keywords: - - sdk - - python ---- - -We've released version 2.0 of the Sumo Logic Python SDK with support for the latest APIs and improved error handling. - -#### What's new - -* Support for Field Extraction Rules API -* Async client support for better performance -* Improved error messages and debugging - -#### Installation - -```python -pip install sumologic-sdk==2.0.0 -``` - -Learn more in the [Python SDK documentation](/docs/api/python-client). -``` +* Link to the SDK's own GitHub releases or changelog #### Deprecations From 2c5df0eb29db2a408803fbee59fe36ae4daeb2da Mon Sep 17 00:00:00 2001 From: Kim Pohas Date: Thu, 10 Sep 2026 16:26:51 -0700 Subject: [PATCH 2/4] add bookmarks where SME guidance needed --- .claude/commands/jira.md | 1 + .claude/commands/release-note-developer.md | 2 ++ .../api/about-apis/terraform-with-sumo-logic.md | 17 ++++++++++------- .../deploy-with-terraform.md | 17 ++++++++++------- .../sumo-logic-open-source-projects.md | 2 +- 5 files changed, 24 insertions(+), 15 deletions(-) diff --git a/.claude/commands/jira.md b/.claude/commands/jira.md index 782b5875e56..e378491cb32 100644 --- a/.claude/commands/jira.md +++ b/.claude/commands/jira.md @@ -73,6 +73,7 @@ Use these keywords and file path patterns to suggest the most relevant Technical **Keywords in content/descriptions:** - **Alerts**: monitor, alert, scheduled search, webhook, notification + - **APIs**: API, endpoint, REST, SDK, authentication, token - **APM**: trace, span, RUM, real user monitoring, application performance - **Apps/Integrations**: app, integration, connector, third-party diff --git a/.claude/commands/release-note-developer.md b/.claude/commands/release-note-developer.md index 91e4d44bf2c..35032418a74 100644 --- a/.claude/commands/release-note-developer.md +++ b/.claude/commands/release-note-developer.md @@ -2,6 +2,8 @@ Automates the creation of Developer release notes for APIs, SDKs, integrations, and platform changes relevant to developers. + + ## What this command does When you invoke `release-note-developer`, Claude will guide you through: diff --git a/docs/api/about-apis/terraform-with-sumo-logic.md b/docs/api/about-apis/terraform-with-sumo-logic.md index 67e9d68c08d..003ef302009 100644 --- a/docs/api/about-apis/terraform-with-sumo-logic.md +++ b/docs/api/about-apis/terraform-with-sumo-logic.md @@ -143,7 +143,7 @@ You can use Terraform data sources to retrieve Sumo Logic data from your Terrafo To use Terraform with Sumo Logic, you need the following: * A Sumo Logic [account](/docs/get-started/sign-up/) * A Sumo Logic [access key](/docs/manage/security/access-keys/) -* [Terraform](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli) +* [Terraform](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli) ## Using Sumo Logic's AWS Terraform template @@ -162,6 +162,9 @@ Perform the following steps to use the template: 1. [Install Python](https://www.python.org/downloads/) (version 3.11 or later). 1. [Install the latest version of the "jq" JSON parser](https://github.com/jqlang/jq/wiki/Installation), necessary to run the `.sh` batch files in the template. 1. [Install the Sumo Logic Python SDK](https://pypi.org/project/sumologic-sdk/). + + + 1. [Install the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html). 1. Next, navigate to the `sumologic-solution-templates` folder where you cloned the repository, and go to the `aws-observability-terraform` subdirectory. Set this directory to be the Terraform working directory by executing the following command: `terraform init` 1. Using the solution template starts with [the main.auto.tfvars file](https://github.com/SumoLogic/sumologic-solution-templates/blob/master/aws-observability-terraform/main.auto.tfvars) which contains variable settings for your Sumo Logic organization, access ID and key, and other configuration information that will be referenced by the other template files. Open this file and fill in each field with the requested information.
tfvars file
Check the [Sumo Logic API endpoints](/docs/api/about-apis/getting-started/#sumo-logic-endpoints-by-deployment-and-firewall-security) if you need help finding the proper deployment value to use. @@ -181,7 +184,7 @@ Perform the following steps to use the template: module "" { source = "./source-module" providers = { aws = aws. } - + aws_account_alias = sumologic_organization_id = var.sumologic_organization_id access_id = var.sumologic_access_id @@ -201,7 +204,7 @@ Perform the following steps to use the template: ## Understanding the Terraform format -Terraform scripts are text files, typically with a `.tf` extension, that use names and values in a hierarchal format, defined by curly braces `{ }`. Terraform scripts can be edited with any text editor, and although they are intended to be run automatically by a computer system, the script elements are generally human-readable and not difficult to parse and understand. +Terraform scripts are text files, typically with a `.tf` extension, that use names and values in a hierarchal format, defined by curly braces `{ }`. Terraform scripts can be edited with any text editor, and although they are intended to be run automatically by a computer system, the script elements are generally human-readable and not difficult to parse and understand. Let's look at some examples: * [Terraform providers](#terraform-providers) @@ -325,7 +328,7 @@ data "httpclient_request" "enable_audit_policy" { provider = http-client username = "${var.sumologic_access_id}" password = "${var.sumologic_access_key}" - url = "${var.sumologic_deployment}v1/policies/audit" + url = "${var.sumologic_deployment}v1/policies/audit" request_method = "PUT" request_headers = { Content-Type: "application/json", @@ -339,7 +342,7 @@ data "httpclient_request" "enable_searchaudit_policy" { provider = http-client username = "${var.sumologic_access_id}" password = "${var.sumologic_access_key}" - url = "${var.sumologic_deployment}v1/policies/searchAudit" + url = "${var.sumologic_deployment}v1/policies/searchAudit" request_method = "PUT" request_headers = { Content-Type: "application/json", @@ -356,7 +359,7 @@ After running Terraform, there is another file type you should be aware of. A *s The state file is used by Terraform to track the current infrastructure state in order to properly process updates or deletes. The state file should be kept safe and secure (since it may contain sensitive data such as access keys and secrets) and is not meant to be edited directly, even though it is a simple human-readable JSON text file. An example state file might look like the screenshot below: -Terraform state file +Terraform state file ## Additional resources @@ -365,4 +368,4 @@ The state file is used by Terraform to track the current infrastructure state in * [Terraform and Sumo Logic – Build Monitoring into your Cloud Infrastructure](https://www.sumologic.com/blog/terraform-sumo-logic) * [Build a detection-as-code pipeline: Your guide to managing Sumo Logic Cloud SIEM rules in GitHub](https://www.sumologic.com/guides/detections-as-code-setup) * Terraform resource: [Sumo Logic Provider](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs) -* GitHub: [terraform-provider-sumologic](https://github.com/SumoLogic/terraform-provider-sumologic) \ No newline at end of file +* GitHub: [terraform-provider-sumologic](https://github.com/SumoLogic/terraform-provider-sumologic) diff --git a/docs/observability/aws/deploy-use-aws-observability/deploy-with-terraform.md b/docs/observability/aws/deploy-use-aws-observability/deploy-with-terraform.md index cbef317af84..b070858985a 100644 --- a/docs/observability/aws/deploy-use-aws-observability/deploy-with-terraform.md +++ b/docs/observability/aws/deploy-use-aws-observability/deploy-with-terraform.md @@ -82,6 +82,9 @@ Before you run the Terraform script, perform the following actions on a server m ```bash jq --version ``` + + + 1. Install Sumo Logic Python SDK using the following command. Click [here](https://pypi.org/project/sumologic-sdk/) to learn more. ```bash pip install sumologic-sdk @@ -697,7 +700,7 @@ collect_cloudwatch_metrics = "Kinesis Firehose Metrics Source" Provide details for the Sumo Logic CloudWatch Metrics source. If not provided, then defaults will be used. -* `limit_to_namespaces`. Enter a comma-delimited list of the namespaces which will be used for both AWS CloudWatch Metrics Source. You can provide both AWS and custom namespaces. +* `limit_to_namespaces`. Enter a comma-delimited list of the namespaces which will be used for both AWS CloudWatch Metrics Source. You can provide both AWS and custom namespaces. Supported namespaces are based on the type of CloudWatch Metrics Source you have selected above. See [AWS Kinesis Firehose for Metrics Source](/docs/send-data/hosted-collectors/amazon-aws/aws-kinesis-firehose-metrics-source) and [Amazon CloudWatch Source for Metrics](/docs/send-data/hosted-collectors/amazon-aws/amazon-cloudwatch-source-metrics) for details on which namespaces they support. @@ -724,7 +727,7 @@ Supported namespaces are based on the type of CloudWatch Metrics Source you have "AWS/NetworkELB", "AWS/SQS", "AWS/SNS" - ], + ], "tag_filters": [], "source_category": "aws/observability/cloudwatch/metrics", "source_name": "CloudWatch Metrics (Region)" @@ -748,7 +751,7 @@ cloudwatch_metrics_source_details = { "AWS/DynamoDB", "AWS/Lambda", "CWAgent" - ], + ], "tag_filters": [{ "type":"TagFilters", "namespace" : "AWS/DynamoDB", @@ -1293,7 +1296,7 @@ auto_enable_logs_subscription="New" ### auto_enable_logs_subscription_options * `filter`. Enter regex for matching logGroups for AWS Lambda only. The regex will check the name. See [Configuring parameters](/docs/send-data/collect-from-other-data-sources/autosubscribe-arn-destination/#configuringparameters). -* `tags_filter`. Enter comma separated key value pairs for filtering logGroups using tags. Ex KeyName1=string,KeyName2=string. This is optional leave it blank if tag based filtering is not needed. See [Configuring parameters](/docs/send-data/collect-from-other-data-sources/autosubscribe-arn-destination/#configuringparameters). +* `tags_filter`. Enter comma separated key value pairs for filtering logGroups using tags. Ex KeyName1=string,KeyName2=string. This is optional leave it blank if tag based filtering is not needed. See [Configuring parameters](/docs/send-data/collect-from-other-data-sources/autosubscribe-arn-destination/#configuringparameters). **Default value:** @@ -1569,13 +1572,13 @@ Refer to step 4 in this [section](/docs/observability/aws/deploy-use-aws-observa Error: waiting for S3 Bucket Policy (bucket-name) delete: found resource ``` #### Solution -Run `terraform destroy` again. +Run `terraform destroy` again. ### Field with the given id can't be deleted because it is in use #### Error Message `"errors":[{"code":"field:cant_be_deleted","message":"Field with the given id can't be deleted because it is in use","meta":{"reason":"Field is used in the Field Extraction Rule"}}]` #### Solution -Run `terraform destroy` again. +Run `terraform destroy` again. ### Hierarchy named 'AWS Observability' already exists @@ -1613,7 +1616,7 @@ Invalid IAM role OR AccessDenied ``` #### Solution -- Refer to [Edit, deactivate/activate, rotate, or delete access keys](/docs/manage/security/access-keys/#edit-deactivateactivate-rotate-or-delete-access-keys) for access keys activation. +- Refer to [Edit, deactivate/activate, rotate, or delete access keys](/docs/manage/security/access-keys/#edit-deactivateactivate-rotate-or-delete-access-keys) for access keys activation. - Refer to [Prerequisites](/docs/observability/aws/deploy-use-aws-observability/before-you-deploy/#prerequisites) for permissions related issues. diff --git a/docs/send-data/collect-from-other-data-sources/sumo-logic-open-source-projects.md b/docs/send-data/collect-from-other-data-sources/sumo-logic-open-source-projects.md index 85e767c789a..8f4f7c60b20 100644 --- a/docs/send-data/collect-from-other-data-sources/sumo-logic-open-source-projects.md +++ b/docs/send-data/collect-from-other-data-sources/sumo-logic-open-source-projects.md @@ -87,4 +87,4 @@ The following open-source solutions are collected in Sumo Logic’s GitHub repos | [sumologic-python-sdk](https://github.com/SumoLogic/sumologic-python-sdk)| This solution is a Community-supported Python interface to the Sumo Logic REST API.| | [Sumotoolbox](https://github.com/voltaire321/sumologictoolbox)| This is a GUI utility for accessing the various Sumo Logic APIs (currently the search, content, and collector APIs.) The idea is to make it easier to perform common API tasks such as copying sources and generating CSV files from searches.| -  + From cb84a726d367001c3d6ed6b1e54fa53b3b37480f Mon Sep 17 00:00:00 2001 From: Kim Pohas Date: Wed, 23 Sep 2026 03:26:15 -0700 Subject: [PATCH 3/4] DOCS-1880 - Resolve SDK support-status questions in AWSO Terraform docs and dev release notes - Add a community-supported/no-support-tickets note next to the sumologic-sdk install step in terraform-with-sumo-logic.md and deploy-with-terraform.md - Remove the awaiting-SME-guidance bookmarks now that the install step is confirmed still needed: it's wired into five live local-exec provisioners in sumologic-solution-templates/aws-observability-terraform/ source-module/update_sources.tf - Remove the #### SDK Updates section and all SDK references from release-note-developer.md. Official release notes are for company-issued releases, and a community-supported package Sumo Logic doesn't take support tickets for doesn't qualify - Remove the resolved bookmark from jira.md's APIs keyword line Co-Authored-By: Claude Sonnet 5 --- .claude/commands/jira.md | 3 +- .claude/commands/release-note-developer.md | 28 +++---------------- .../about-apis/terraform-with-sumo-logic.md | 5 +--- .../deploy-with-terraform.md | 5 +--- 4 files changed, 7 insertions(+), 34 deletions(-) diff --git a/.claude/commands/jira.md b/.claude/commands/jira.md index e378491cb32..3597b06280b 100644 --- a/.claude/commands/jira.md +++ b/.claude/commands/jira.md @@ -72,8 +72,7 @@ Use these keywords and file path patterns to suggest the most relevant Technical **Keywords in content/descriptions:** -- **Alerts**: monitor, alert, scheduled search, webhook, notification - +- **Alerts**: monitor, alert, scheduled search, webhook, notification - **APIs**: API, endpoint, REST, SDK, authentication, token - **APM**: trace, span, RUM, real user monitoring, application performance - **Apps/Integrations**: app, integration, connector, third-party diff --git a/.claude/commands/release-note-developer.md b/.claude/commands/release-note-developer.md index 35032418a74..73f66e249e4 100644 --- a/.claude/commands/release-note-developer.md +++ b/.claude/commands/release-note-developer.md @@ -1,8 +1,6 @@ # Create New Developer Release Note -Automates the creation of Developer release notes for APIs, SDKs, integrations, and platform changes relevant to developers. - - +Automates the creation of Developer release notes for APIs, integrations, and platform changes relevant to developers. ## What this command does @@ -17,7 +15,6 @@ When you invoke `release-note-developer`, Claude will guide you through: * Announcing new API endpoints or features * Documenting API changes, deprecations, or breaking changes -* Publishing SDK updates or new SDK versions * Releasing developer tools or CLI updates * Announcing platform changes affecting developers * Documenting authentication or integration changes @@ -28,7 +25,6 @@ When you invoke `release-note-developer`, Claude will guide you through: Developer release notes typically cover: * **APIs**. New endpoints, changes, deprecations -* **SDKs**. New SDKs, version updates, improvements * **CLI**. Command-line tool updates * **Integrations**. New integrations or integration changes * **Platform**. Platform changes affecting developers @@ -74,7 +70,6 @@ blog-developer/YYYY-MM-DD-{slug}.md Examples: * `blog-developer/2026-03-23-api-endpoints.md` * `blog-developer/2026-04-09-india-datacenter-deprecation.md` -* `blog-developer/2026-05-15-python-sdk-v2.md` **Important**: Files are created in `/blog-developer/` directory (root level, no subdirectories) @@ -108,7 +103,6 @@ hide_table_of_contents: true * **Always ask user if they want to include keywords** * Suggest keywords based on content type: * API changes: `api`, `endpoints`, `rest-api` - * SDK updates: `sdk`, `python`, `java`, etc. * Deprecations: `deprecation`, `end-of-life` * Breaking changes: `breaking-change` * Platform updates: `platform`, `datacenter` @@ -132,8 +126,8 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; **Title guidelines:** * Keep concise (2-5 words) * Use title case -* Common patterns: "APIs", "SDKs", "CLI Tools", "Platform Updates" -* Can be more specific: "Python SDK", "REST API", "Management APIs" +* Common patterns: "APIs", "CLI Tools", "Platform Updates" +* Can be more specific: "REST API", "Management APIs" ### Step 5: Write content @@ -186,14 +180,6 @@ We're excited to announce new API endpoints for managing Field Extraction Rules **Monitors API**: The `notificationGroupFields` parameter is now required when creating monitors. Update your integrations before June 1, 2026. See the [Monitors API documentation](/docs/api/monitors) for details. ``` -#### SDK Updates - -For SDK releases: -* Version number -* What's new or changed -* Installation instructions -* Link to the SDK's own GitHub releases or changelog - #### Deprecations For deprecation notices: @@ -279,7 +265,7 @@ Before finishing, verify: * [ ] Content is clear and includes relevant links * [ ] Breaking changes are clearly marked (use bold or H4 sections) * [ ] Documentation links use relative paths (start with `/docs/`) -* [ ] Keywords added if applicable (deprecation, api, sdk, etc.) +* [ ] Keywords added if applicable (deprecation, api, etc.) * [ ] No trailing whitespace ## Example usage @@ -457,12 +443,6 @@ Would you like me to help refine the content or add additional details? * Provide migration path with examples * Offer support contact for questions -**For SDK releases:** -* Include version number prominently -* Show installation/upgrade commands -* Highlight breaking changes separately -* Link to changelog or GitHub release - **All release notes:** * Write for developers (assume technical knowledge) * Focus on impact and action items diff --git a/docs/api/about-apis/terraform-with-sumo-logic.md b/docs/api/about-apis/terraform-with-sumo-logic.md index 003ef302009..601baae6623 100644 --- a/docs/api/about-apis/terraform-with-sumo-logic.md +++ b/docs/api/about-apis/terraform-with-sumo-logic.md @@ -161,10 +161,7 @@ Perform the following steps to use the template: 1. [Install Terraform](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli) (version 1.6 or later). 1. [Install Python](https://www.python.org/downloads/) (version 3.11 or later). 1. [Install the latest version of the "jq" JSON parser](https://github.com/jqlang/jq/wiki/Installation), necessary to run the `.sh` batch files in the template. - 1. [Install the Sumo Logic Python SDK](https://pypi.org/project/sumologic-sdk/). - - - + 1. [Install the Sumo Logic Python SDK](https://pypi.org/project/sumologic-sdk/). This is a community-supported package; Sumo Logic doesn't take support tickets for it. 1. [Install the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html). 1. Next, navigate to the `sumologic-solution-templates` folder where you cloned the repository, and go to the `aws-observability-terraform` subdirectory. Set this directory to be the Terraform working directory by executing the following command: `terraform init` 1. Using the solution template starts with [the main.auto.tfvars file](https://github.com/SumoLogic/sumologic-solution-templates/blob/master/aws-observability-terraform/main.auto.tfvars) which contains variable settings for your Sumo Logic organization, access ID and key, and other configuration information that will be referenced by the other template files. Open this file and fill in each field with the requested information.
tfvars file
Check the [Sumo Logic API endpoints](/docs/api/about-apis/getting-started/#sumo-logic-endpoints-by-deployment-and-firewall-security) if you need help finding the proper deployment value to use. diff --git a/docs/observability/aws/deploy-use-aws-observability/deploy-with-terraform.md b/docs/observability/aws/deploy-use-aws-observability/deploy-with-terraform.md index b070858985a..86ee13f64ba 100644 --- a/docs/observability/aws/deploy-use-aws-observability/deploy-with-terraform.md +++ b/docs/observability/aws/deploy-use-aws-observability/deploy-with-terraform.md @@ -82,10 +82,7 @@ Before you run the Terraform script, perform the following actions on a server m ```bash jq --version ``` - - - -1. Install Sumo Logic Python SDK using the following command. Click [here](https://pypi.org/project/sumologic-sdk/) to learn more. +1. Install Sumo Logic Python SDK using the following command. This is a community-supported package; Sumo Logic doesn't take support tickets for it ([learn more](https://pypi.org/project/sumologic-sdk/)). ```bash pip install sumologic-sdk ``` From f91f0e44b373172751f20ac2aad819b1aeb7b3ad Mon Sep 17 00:00:00 2001 From: Kim Pohas Date: Wed, 23 Sep 2026 11:53:11 -0700 Subject: [PATCH 4/4] DOCS-1880 - Revert accidental whitespace changes Restore the Terraform docs, jira.md, and the open source projects page to main, keeping only the community-supported SDK note. Drops the stray awaiting-SME-guidance comment. Co-Authored-By: Claude Sonnet 5 --- .claude/commands/jira.md | 2 +- docs/api/about-apis/terraform-with-sumo-logic.md | 14 +++++++------- .../v2.15.0/deploy-with-terraform.md | 14 +++++++------- .../sumo-logic-open-source-projects.md | 2 +- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/.claude/commands/jira.md b/.claude/commands/jira.md index 3597b06280b..782b5875e56 100644 --- a/.claude/commands/jira.md +++ b/.claude/commands/jira.md @@ -72,7 +72,7 @@ Use these keywords and file path patterns to suggest the most relevant Technical **Keywords in content/descriptions:** -- **Alerts**: monitor, alert, scheduled search, webhook, notification +- **Alerts**: monitor, alert, scheduled search, webhook, notification - **APIs**: API, endpoint, REST, SDK, authentication, token - **APM**: trace, span, RUM, real user monitoring, application performance - **Apps/Integrations**: app, integration, connector, third-party diff --git a/docs/api/about-apis/terraform-with-sumo-logic.md b/docs/api/about-apis/terraform-with-sumo-logic.md index 8beef965d6e..bc6abec701d 100644 --- a/docs/api/about-apis/terraform-with-sumo-logic.md +++ b/docs/api/about-apis/terraform-with-sumo-logic.md @@ -143,7 +143,7 @@ You can use Terraform data sources to retrieve Sumo Logic data from your Terrafo To use Terraform with Sumo Logic, you need the following: * A Sumo Logic [account](/docs/get-started/sign-up/) * A Sumo Logic [access key](/docs/manage/security/access-keys/) -* [Terraform](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli) +* [Terraform](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli) ## Using Sumo Logic's AWS Terraform template @@ -181,7 +181,7 @@ Perform the following steps to use the template: module "" { source = "./source-module" providers = { aws = aws. } - + aws_account_alias = sumologic_organization_id = var.sumologic_organization_id access_id = var.sumologic_access_id @@ -201,7 +201,7 @@ Perform the following steps to use the template: ## Understanding the Terraform format -Terraform scripts are text files, typically with a `.tf` extension, that use names and values in a hierarchal format, defined by curly braces `{ }`. Terraform scripts can be edited with any text editor, and although they are intended to be run automatically by a computer system, the script elements are generally human-readable and not difficult to parse and understand. +Terraform scripts are text files, typically with a `.tf` extension, that use names and values in a hierarchal format, defined by curly braces `{ }`. Terraform scripts can be edited with any text editor, and although they are intended to be run automatically by a computer system, the script elements are generally human-readable and not difficult to parse and understand. Let's look at some examples: * [Terraform providers](#terraform-providers) @@ -325,7 +325,7 @@ data "httpclient_request" "enable_audit_policy" { provider = http-client username = "${var.sumologic_access_id}" password = "${var.sumologic_access_key}" - url = "${var.sumologic_deployment}v1/policies/audit" + url = "${var.sumologic_deployment}v1/policies/audit" request_method = "PUT" request_headers = { Content-Type: "application/json", @@ -339,7 +339,7 @@ data "httpclient_request" "enable_searchaudit_policy" { provider = http-client username = "${var.sumologic_access_id}" password = "${var.sumologic_access_key}" - url = "${var.sumologic_deployment}v1/policies/searchAudit" + url = "${var.sumologic_deployment}v1/policies/searchAudit" request_method = "PUT" request_headers = { Content-Type: "application/json", @@ -356,7 +356,7 @@ After running Terraform, there is another file type you should be aware of. A *s The state file is used by Terraform to track the current infrastructure state in order to properly process updates or deletes. The state file should be kept safe and secure (since it may contain sensitive data such as access keys and secrets) and is not meant to be edited directly, even though it is a simple human-readable JSON text file. An example state file might look like the screenshot below: -Terraform state file +Terraform state file ## Additional resources @@ -365,4 +365,4 @@ The state file is used by Terraform to track the current infrastructure state in * [Terraform and Sumo Logic – Build Monitoring into your Cloud Infrastructure](https://www.sumologic.com/blog/terraform-sumo-logic) * [Build a detection-as-code pipeline: Your guide to managing Sumo Logic Cloud SIEM rules in GitHub](https://www.sumologic.com/guides/detections-as-code-setup) * Terraform resource: [Sumo Logic Provider](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs) -* GitHub: [terraform-provider-sumologic](https://github.com/SumoLogic/terraform-provider-sumologic) +* GitHub: [terraform-provider-sumologic](https://github.com/SumoLogic/terraform-provider-sumologic) \ No newline at end of file diff --git a/docs/observability/aws/deploy-use-aws-observability/v2.15.0/deploy-with-terraform.md b/docs/observability/aws/deploy-use-aws-observability/v2.15.0/deploy-with-terraform.md index 1de9f2afbe2..3840008478d 100644 --- a/docs/observability/aws/deploy-use-aws-observability/v2.15.0/deploy-with-terraform.md +++ b/docs/observability/aws/deploy-use-aws-observability/v2.15.0/deploy-with-terraform.md @@ -697,7 +697,7 @@ collect_cloudwatch_metrics = "Kinesis Firehose Metrics Source" Provide details for the Sumo Logic CloudWatch Metrics source. If not provided, then defaults will be used. -* `limit_to_namespaces`. Enter a comma-delimited list of the namespaces which will be used for both AWS CloudWatch Metrics Source. You can provide both AWS and custom namespaces. +* `limit_to_namespaces`. Enter a comma-delimited list of the namespaces which will be used for both AWS CloudWatch Metrics Source. You can provide both AWS and custom namespaces. Supported namespaces are based on the type of CloudWatch Metrics Source you have selected above. See [AWS Kinesis Firehose for Metrics Source](/docs/send-data/hosted-collectors/amazon-aws/aws-kinesis-firehose-metrics-source) and [Amazon CloudWatch Source for Metrics](/docs/send-data/hosted-collectors/amazon-aws/amazon-cloudwatch-source-metrics) for details on which namespaces they support. @@ -724,7 +724,7 @@ Supported namespaces are based on the type of CloudWatch Metrics Source you have "AWS/NetworkELB", "AWS/SQS", "AWS/SNS" - ], + ], "tag_filters": [], "source_category": "aws/observability/cloudwatch/metrics", "source_name": "CloudWatch Metrics (Region)" @@ -748,7 +748,7 @@ cloudwatch_metrics_source_details = { "AWS/DynamoDB", "AWS/Lambda", "CWAgent" - ], + ], "tag_filters": [{ "type":"TagFilters", "namespace" : "AWS/DynamoDB", @@ -1293,7 +1293,7 @@ auto_enable_logs_subscription="New" ### auto_enable_logs_subscription_options * `filter`. Enter regex for matching logGroups for AWS Lambda only. The regex will check the name. See [Configuring parameters](/docs/send-data/collect-from-other-data-sources/autosubscribe-arn-destination/#configuringparameters). -* `tags_filter`. Enter comma separated key value pairs for filtering logGroups using tags. Ex KeyName1=string,KeyName2=string. This is optional leave it blank if tag based filtering is not needed. See [Configuring parameters](/docs/send-data/collect-from-other-data-sources/autosubscribe-arn-destination/#configuringparameters). +* `tags_filter`. Enter comma separated key value pairs for filtering logGroups using tags. Ex KeyName1=string,KeyName2=string. This is optional leave it blank if tag based filtering is not needed. See [Configuring parameters](/docs/send-data/collect-from-other-data-sources/autosubscribe-arn-destination/#configuringparameters). **Default value:** @@ -1569,13 +1569,13 @@ Refer to step 4 in this [section](/docs/observability/aws/deploy-use-aws-observa Error: waiting for S3 Bucket Policy (bucket-name) delete: found resource ``` #### Solution -Run `terraform destroy` again. +Run `terraform destroy` again. ### Field with the given id can't be deleted because it is in use #### Error Message `"errors":[{"code":"field:cant_be_deleted","message":"Field with the given id can't be deleted because it is in use","meta":{"reason":"Field is used in the Field Extraction Rule"}}]` #### Solution -Run `terraform destroy` again. +Run `terraform destroy` again. ### Hierarchy named 'AWS Observability' already exists @@ -1613,7 +1613,7 @@ Invalid IAM role OR AccessDenied ``` #### Solution -- Refer to [Edit, activate/deactivate, rotate, or delete access keys](/docs/manage/security/access-keys/#edit-deactivateactivate-rotate-or-delete-access-keys) for access keys activation. +- Refer to [Edit, activate/deactivate, rotate, or delete access keys](/docs/manage/security/access-keys/#edit-deactivateactivate-rotate-or-delete-access-keys) for access keys activation. - Refer to [Prerequisites](/docs/observability/aws/deploy-use-aws-observability/v2.15.0/before-you-deploy/#prerequisites) for permissions related issues. diff --git a/docs/send-data/collect-from-other-data-sources/sumo-logic-open-source-projects.md b/docs/send-data/collect-from-other-data-sources/sumo-logic-open-source-projects.md index 8f4f7c60b20..85e767c789a 100644 --- a/docs/send-data/collect-from-other-data-sources/sumo-logic-open-source-projects.md +++ b/docs/send-data/collect-from-other-data-sources/sumo-logic-open-source-projects.md @@ -87,4 +87,4 @@ The following open-source solutions are collected in Sumo Logic’s GitHub repos | [sumologic-python-sdk](https://github.com/SumoLogic/sumologic-python-sdk)| This solution is a Community-supported Python interface to the Sumo Logic REST API.| | [Sumotoolbox](https://github.com/voltaire321/sumologictoolbox)| This is a GUI utility for accessing the various Sumo Logic APIs (currently the search, content, and collector APIs.) The idea is to make it easier to perform common API tasks such as copying sources and generating CSV files from searches.| - +