Reference - Centralized Logging with OpenSearch

Reference

This section includes information about an optional feature for collecting anonymized metrics for this solution and a list of builders who contributed to this solution.

Anonymized data collection

This solution includes an option to send anonymized operational metrics to AWS. We use this data to better understand how customers use this solution and related services and products. When invoked, the following information is collected and sent to AWS:

  • Solution ID - The AWS solution identifier

  • Unique ID (UUID) - Randomly generated, unique identifier for each Centralized Logging with OpenSearch deployment

  • Timestamp - Data-collection timestamp

  • Version - Solution version deployed

  • Data - Data includes Region where the solution stack is deployed, request type (whether the stack was created, updated, or deleted), template type used, log pipeline parameters, log pipeline alarm parameters, and OpenSearch version and size.

Examples of collected data by type:

Stack Deployment Data

{ "Region": "us-east-1", "RequestType": "Create", "Template": "CentralizedLogging" }

Pipeline Management Data

{ "metricType": "PIPELINE_MANAGEMENT", "isCrossAccountIngestion": false, "sourceType": "RDS", "engineType": "OpenSearch", "logProcessorType": "AWS Lambda", "pipelineType": "Service", "region": "us-east-1", "logSourceType": "S3", "status": "CREATE_COMPLETE", "pipelineId": "aee1c87c-2531-4fd1-b600-0c8071556967" }

Pipeline Alarm Management Data

{ "metricType": "PIPELINE_ALARM_MANAGEMENT", "pipelineType": "APP", "region": "us-east-1", "operation": "CREATE", "pipelineId": "dc8c1afa-1e22-4397-8c8b-963df8ac688a" }

OpenSearch Metrics Data

{ "metricType": "OPENSEARCH_METRICS", "proxyEnabled": true, "freeStorageSpace": 7000, "nodeCount": 2, "region": "us-east-1", "domainVersion": "2.17", "domainId": "cb25869992309965be0f36096463bcb9", "clusterUsedSpace": 100 }

AWS owns the data gathered through this survey. Data collection is subject to the AWS Privacy Notice. To opt out of this feature, complete the following steps before launching the AWS CloudFormation template.

  1. Download the solution CloudFormation templates from the solution landing page to your local hard drive.

  2. Open the CloudFormation template with a text editor.

  3. Modify the CloudFormation template mapping section from:

    AnonymousData:
      SendAnonymizedUsageData:
        Data: Yes

    to:

    AnonymousData:
      SendAnonymizedUsageData:
        Data: No
  4. Sign in to the AWS CloudFormation console.

  5. Select Create stack.

  6. On the Create stack page, Specify template section, select Upload a template file.

  7. Under Upload a template file, choose Choose file and select the edited template from your local drive.

  8. Choose Next and follow the steps in the Automated deployment section of this guide.

Contributors

  • Manish Jangid

  • Bryce Lee

  • Owen Chang

  • Haiyun Chen

  • Aiden Dai

  • Lalit Grover

  • Eva Liu

  • Robin Luo

  • James Ma

  • Joe Shi

  • Charles Wei

  • Ming Xu