AWS prescriptive-guidance documentation change
Summary
Replaced colons with en dashes in bullet points for consistent formatting
Security assessment
The change is purely cosmetic punctuation formatting (colon to en dash) in existing logging best practices. No security content was added, modified, or removed. The existing security recommendation about encrypting logs and access controls remains unchanged.
Diff
diff --git a/prescriptive-guidance/latest/amazon-eks-observability-best-practices/logging-best-practices.md b/prescriptive-guidance/latest/amazon-eks-observability-best-practices/logging-best-practices.md index 9243b99ef..b67f319a6 100644 --- a//prescriptive-guidance/latest/amazon-eks-observability-best-practices/logging-best-practices.md +++ b//prescriptive-guidance/latest/amazon-eks-observability-best-practices/logging-best-practices.md @@ -11 +11 @@ The following best practices help create a robust, scalable, and efficient loggi - * **Centralize log collection** : Use a centralized logging solution such as CloudWatch Logs, Elasticsearch, or a third-party service to aggregate logs from all components. This provides a single point of access for log analysis and simplifies management. + * **Centralize log collection** – Use a centralized logging solution such as CloudWatch Logs, Elasticsearch, or a third-party service to aggregate logs from all components. This provides a single point of access for log analysis and simplifies management. @@ -13 +13 @@ The following best practices help create a robust, scalable, and efficient loggi - * **Implement structured logging** : Use structured log formats such as JSON so that logs can be parsed and searched more easily. Include relevant metadata such as timestamps, log levels, and source identifiers. + * **Implement structured logging** – Use structured log formats such as JSON so that logs can be parsed and searched more easily. Include relevant metadata such as timestamps, log levels, and source identifiers. @@ -15 +15 @@ The following best practices help create a robust, scalable, and efficient loggi - * **Use log levels appropriately** : Implement proper log levels (such as `DEBUG`, `INFO`, `WARN`, and `ERROR`) in your applications. Configure production environments to log at appropriate levels to avoid excessive logging. + * **Use log levels appropriately** – Implement proper log levels (such as `DEBUG`, `INFO`, `WARN`, and `ERROR`) in your applications. Configure production environments to log at appropriate levels to avoid excessive logging. @@ -17 +17 @@ The following best practices help create a robust, scalable, and efficient loggi - * **Enable container logging** : Configure your containers to log to `stdout` and `stderr`. This allows Kubernetes to capture and forward these logs to your chosen logging solution. + * **Enable container logging** – Configure your containers to log to `stdout` and `stderr`. This allows Kubernetes to capture and forward these logs to your chosen logging solution. @@ -19 +19 @@ The following best practices help create a robust, scalable, and efficient loggi - * **Enable application logging** : Configure applications to write logs to `stdout` and `stderr` instead of writing to log files. This follows the [12-factor app methodology](https://12factor.net/logs) and aligns with cloud-native best practices. + * **Enable application logging** – Configure applications to write logs to `stdout` and `stderr` instead of writing to log files. This follows the [12-factor app methodology](https://12factor.net/logs) and aligns with cloud-native best practices. @@ -21 +21 @@ The following best practices help create a robust, scalable, and efficient loggi - * **Use Kubernetes DaemonSets for log collection** : Deploy log collection agents (such as Fluent Bit) as DaemonSets to ensure that they run on every node in your cluster. + * **Use Kubernetes DaemonSets for log collection** – Deploy log collection agents (such as Fluent Bit) as DaemonSets to ensure that they run on every node in your cluster. @@ -23 +23 @@ The following best practices help create a robust, scalable, and efficient loggi - * **Implement retention policies** : Define and enforce log retention policies to comply with regulations and to manage storage costs. + * **Implement retention policies** – Define and enforce log retention policies to comply with regulations and to manage storage costs. @@ -25 +25 @@ The following best practices help create a robust, scalable, and efficient loggi - * **Secure log data** : Encrypt logs in transit and at rest. Implement access controls to restrict who can view and manage logs. + * **Secure log data** – Encrypt logs in transit and at rest. Implement access controls to restrict who can view and manage logs. @@ -27 +27 @@ The following best practices help create a robust, scalable, and efficient loggi - * **Monitor log ingestion** : Set up alerts for log ingestion failures or delays to ensure continuous logging. + * **Monitor log ingestion** – Set up alerts for log ingestion failures or delays to ensure continuous logging. @@ -29 +29 @@ The following best practices help create a robust, scalable, and efficient loggi - * **Use Kubernetes annotations and labels** : Use Kubernetes annotations and labels to add metadata to your logs, to improve searchability and filtering. + * **Use Kubernetes annotations and labels** – Use Kubernetes annotations and labels to add metadata to your logs, to improve searchability and filtering. @@ -31 +31 @@ The following best practices help create a robust, scalable, and efficient loggi - * **Implement distributed tracing** : Use distributed tracing tools such as [AWS X-Ray](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray.html) or Jaeger to correlate logs across microservices. + * **Implement distributed tracing** – Use distributed tracing tools such as [AWS X-Ray](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray.html) or Jaeger to correlate logs across microservices. @@ -33 +33 @@ The following best practices help create a robust, scalable, and efficient loggi - * **Optimize log volume** : Be selective about what you log to avoid unnecessary costs and performance issues. Use sampling for high-volume, low-value logs. + * **Optimize log volume** – Be selective about what you log to avoid unnecessary costs and performance issues. Use sampling for high-volume, low-value logs. @@ -35 +35 @@ The following best practices help create a robust, scalable, and efficient loggi - * **Implement log aggregation** : Use tools such as Logstash to aggregate logs from multiple sources before sending them to your central logging system. + * **Implement log aggregation** – Use tools such as Logstash to aggregate logs from multiple sources before sending them to your central logging system. @@ -37 +37 @@ The following best practices help create a robust, scalable, and efficient loggi - * **Use AWS services when possible** : Services such as CloudWatch Logs and Container Insights provide seamless integration with other AWS services. + * **Use AWS services when possible** – Services such as CloudWatch Logs and Container Insights provide seamless integration with other AWS services. @@ -39 +39 @@ The following best practices help create a robust, scalable, and efficient loggi - * **Implement log analysis and visualization** : Use tools such as CloudWatch Logs Insights, Elasticsearch with Kibana, or third-party solutions for log analysis and visualization. + * **Implement log analysis and visualization** – Use tools such as CloudWatch Logs Insights, Elasticsearch with Kibana, or third-party solutions for log analysis and visualization. @@ -41 +41 @@ The following best practices help create a robust, scalable, and efficient loggi - * **Implement automated log analysis** : Use machine learning and AI-powered tools to detect anomalies and patterns in your logs automatically. + * **Implement automated log analysis** – Use machine learning and AI-powered tools to detect anomalies and patterns in your logs automatically. @@ -43 +43 @@ The following best practices help create a robust, scalable, and efficient loggi - * **Document your logging strategy** : Maintain clear documentation of your logging architecture, practices, and tools for your team. + * **Document your logging strategy** – Maintain clear documentation of your logging architecture, practices, and tools for your team.