AWS prescriptive-guidance documentation change
Summary
Replaced colons with en dashes in bullet point formatting throughout the document
Security assessment
The changes are purely cosmetic formatting updates (changing ':' to '–'). No security-related content was added, removed, or modified. Existing security recommendations about log encryption and sensitive data remain unchanged.
Diff
diff --git a/prescriptive-guidance/latest/amazon-eks-observability-best-practices/logging-considerations.md b/prescriptive-guidance/latest/amazon-eks-observability-best-practices/logging-considerations.md index 617b8937b..bcb161d89 100644 --- a//prescriptive-guidance/latest/amazon-eks-observability-best-practices/logging-considerations.md +++ b//prescriptive-guidance/latest/amazon-eks-observability-best-practices/logging-considerations.md @@ -11 +11 @@ This section discusses important considerations to keep in mind when you impleme - * **Performance impact** : Excessive logging can affect application performance. Be mindful of the volume and frequency of logs generated. + * **Performance impact** – Excessive logging can affect application performance. Be mindful of the volume and frequency of logs generated. @@ -13 +13 @@ This section discusses important considerations to keep in mind when you impleme - * **Cost management** : Log storage and processing can incur significant costs, especially at scale. Implement log retention policies and consider using log aggregation to reduce costs. + * **Cost management** – Log storage and processing can incur significant costs, especially at scale. Implement log retention policies and consider using log aggregation to reduce costs. @@ -15 +15 @@ This section discusses important considerations to keep in mind when you impleme - * **Security and compliance** : Make sure that logs don't contain sensitive information such as passwords or personal data. Implement encryption for logs in transit and at rest. Consider compliance requirements such as General Data Protection Regulation (GDPR) or Health Insurance Portability and Accountability Act (HIPAA) when you handle logs. + * **Security and compliance** – Make sure that logs don't contain sensitive information such as passwords or personal data. Implement encryption for logs in transit and at rest. Consider compliance requirements such as General Data Protection Regulation (GDPR) or Health Insurance Portability and Accountability Act (HIPAA) when you handle logs. @@ -17 +17 @@ This section discusses important considerations to keep in mind when you impleme - * **Scalability** : Make sure that your logging solution can scale with your cluster size and log volume. Consider using buffering and batching for log transmission. + * **Scalability** – Make sure that your logging solution can scale with your cluster size and log volume. Consider using buffering and batching for log transmission. @@ -19 +19 @@ This section discusses important considerations to keep in mind when you impleme - * **Log retention** : Define and implement appropriate log retention periods. Balance compliance requirements against storage costs. + * **Log retention** – Define and implement appropriate log retention periods. Balance compliance requirements against storage costs. @@ -21 +21 @@ This section discusses important considerations to keep in mind when you impleme - * **Access control** : Implement proper AWS Identity and Access Management (IAM) roles and policies for log access. Follow the [least privilege principle](https://docs.aws.amazon.com/wellarchitected/latest/security-pillar/sec_permissions_least_privileges.html) for log management. + * **Access control** – Implement proper AWS Identity and Access Management (IAM) roles and policies for log access. Follow the [least privilege principle](https://docs.aws.amazon.com/wellarchitected/latest/security-pillar/sec_permissions_least_privileges.html) for log management. @@ -23 +23 @@ This section discusses important considerations to keep in mind when you impleme - * **Log consistency** : Use consistent log formats across different applications and services. Use structured logging for easier parsing and analysis. + * **Log consistency** – Use consistent log formats across different applications and services. Use structured logging for easier parsing and analysis. @@ -25 +25 @@ This section discusses important considerations to keep in mind when you impleme - * **Time synchronization** : Synchronize time across all nodes to get consistent timestamps in logs. + * **Time synchronization** – Synchronize time across all nodes to get consistent timestamps in logs. @@ -27 +27 @@ This section discusses important considerations to keep in mind when you impleme - * **Resource allocation** : Allocate appropriate resources (such as CPU and memory) for logging agents. Monitor the resource usage of logging components. + * **Resource allocation** – Allocate appropriate resources (such as CPU and memory) for logging agents. Monitor the resource usage of logging components. @@ -29 +29 @@ This section discusses important considerations to keep in mind when you impleme - * **Fargate considerations** : Fargate has specific logging mechanisms that differ from EC2-based nodes. Understand the limitations and capabilities of [Fargate logging](https://docs.aws.amazon.com/eks/latest/userguide/fargate-logging.html). + * **Fargate considerations** – Fargate has specific logging mechanisms that differ from EC2-based nodes. Understand the limitations and capabilities of [Fargate logging](https://docs.aws.amazon.com/eks/latest/userguide/fargate-logging.html). @@ -31 +31 @@ This section discusses important considerations to keep in mind when you impleme - * **Multi-tenant clusters** : In multi-tenant environments, make sure that logs are properly isolated between tenants. + * **Multi-tenant clusters** – In multi-tenant environments, make sure that logs are properly isolated between tenants. @@ -33 +33 @@ This section discusses important considerations to keep in mind when you impleme - * **Log parsing and analysis** : Consider the tools and skills required for effective log analysis. Implement log parsing for structured data extraction. + * **Log parsing and analysis** – Consider the tools and skills required for effective log analysis. Implement log parsing for structured data extraction. @@ -35 +35 @@ This section discusses important considerations to keep in mind when you impleme - * **Monitoring the logging system** : Set up monitoring for the logging infrastructure itself. Generate alerts for logging system failures or backlogs. + * **Monitoring the logging system** – Set up monitoring for the logging infrastructure itself. Generate alerts for logging system failures or backlogs. @@ -37 +37 @@ This section discusses important considerations to keep in mind when you impleme - * **Network impact** : Be aware of the network bandwidth used by log transmission. Consider using compression for log data. + * **Network impact** – Be aware of the network bandwidth used by log transmission. Consider using compression for log data. @@ -39 +39 @@ This section discusses important considerations to keep in mind when you impleme - * **Kubernetes events** : Don't overlook Kubernetes events as a source of important information. + * **Kubernetes events** – Don't overlook Kubernetes events as a source of important information. @@ -41 +41 @@ This section discusses important considerations to keep in mind when you impleme - * **Control plane logging** : Understand the implications and costs of enabling control plane logging. + * **Control plane logging** – Understand the implications and costs of enabling control plane logging. @@ -43 +43 @@ This section discusses important considerations to keep in mind when you impleme - * **Debugging capabilities** : Make sure that your logging solution allows for easy debugging and troubleshooting. + * **Debugging capabilities** – Make sure that your logging solution allows for easy debugging and troubleshooting. @@ -45 +45 @@ This section discusses important considerations to keep in mind when you impleme - * **Integration with existing tools** : Consider how your Amazon EKS logging solution integrates with existing monitoring and alerting tools. + * **Integration with existing tools** – Consider how your Amazon EKS logging solution integrates with existing monitoring and alerting tools. @@ -47 +47 @@ This section discusses important considerations to keep in mind when you impleme - * **Testing** : Regularly test your logging setup, especially after cluster upgrades. + * **Testing** – Regularly test your logging setup, especially after cluster upgrades. @@ -49 +49 @@ This section discusses important considerations to keep in mind when you impleme - * **Documentation** : Maintain clear documentation of your logging architecture and practices. + * **Documentation** – Maintain clear documentation of your logging architecture and practices. @@ -51 +51 @@ This section discusses important considerations to keep in mind when you impleme - * **Log aggregation latency** : Be aware of any latency in log aggregation and how it might affect real-time monitoring. + * **Log aggregation latency** – Be aware of any latency in log aggregation and how it might affect real-time monitoring.