Skip to content

Normalize Elastic index naming convention to lowercase and dot-separa… #323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
umarkumark merged 1 commit into from
Mar 18, 2026
Merged

Normalize Elastic index naming convention to lowercase and dot-separa… #323

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions software-engineering-policies/Logging/GuidanceForLoggingToElasticCloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,24 @@ Architectural Practice Forum is required in these cases.
## Elastic Index Naming Convention

Logs should be indexed in ElasticSearch according to the following convention:
**FullServiceName-environment-category**. The Observability team automation
**fullServiceName.environment.category**. The Observability team automation
creates indexes, so teams should not need to create them manually. Teams
with legacy indexes should be migrated to the new naming convention.

### Diagnostic logs

Should ingest into a dedicated ElasticSearch index named as e.g.,
`SalesCatalogueService-Dev1-Diagnostic`
`salesCatalogueService.dev1.diagnostic`

### Audit/Metric logs

Should ingest into a dedicated ElasticSearch index named as e.g.,
`SalesCatalogueService-Dev1-Audit`
`salesCatalogueService.dev1.audit`

### Request/response logging

Should ingest into a dedicated ElasticSearch index named as e.g.,
`SalesCatalogueService-Dev1-HTTP`
`salesCatalogueService.dev1.http`

## Retention implementation in Elastic Cloud

Expand Down
Loading