Het opstellen van uitgebreide documentatie voor logstandaarden binnen je ELK Stack is essentieel voor consistente, onderhoudbare en conforme loggingpraktijken. Hieronder vind je richtlijnen, sjablonen en best practices die je kunt opnemen: 1. Inleiding en doelstelling - Purpose van de logstandaarden - Belang van consistente en gestructureerde logs 2. Logformaten en structuur - Gestructureerde logs in JSON-formaat - Standaard velden: * timestamp (ISO 8601) * logniveau (bijv. INFO, WARN, ERROR) * bron (bijv. service, module) * bericht (beschrijving van gebeurtenis) * context (extra gegevens, zoals userID, sessionID) 3. Tijdstempel standaarden - Gebruik ISO 8601 formaat: `YYYY-MM-DDTHH:MM:SSZ` (bijvoorbeeld `2024-04-27T14:30:00Z`) - Consistent gebruik van UTC-tijd - Automatische generatie van tijdstempels in loggeneratie 4. Logniveaus en categorisering - Definieer duidelijk de niveaus: DEBUG, INFO, WARN, ERROR, FATAL - Richtlijnen voor wanneer welk niveau te gebruiken 5. Velden en datatypes - Beschrijf alle vaste velden en hun datatype - Optionele velden en hun gebruik - Validatie- en validatierichtlijnen 6. Best practices voor loginhoud - Vermijd gevoelige informatie (pincode, wachtwoorden) - Wees specifiek en duidelijk in berichten - Gebruik consistente terminologie - Voeg relevante context toe 7. Loggeneratie en -verwerking - Gebruik van logbibliotheken/SDK’s die JSON ondersteunen - Injectie van gestructureerde data - Automatisering en standaardisatie in code 8. Naleving en compliance - Voldoen aan regelgeving zoals AVG - Beveiliging van logs (toegangsbeheer, encryptie) 9. Onderhoud en evolutie - Versiebeheer van logstandaarden - Periodieke review en updates - Documentatie van afwijkingen en uitzonderingen 10. Sjabloon voor logberichten { "timestamp": "2024-04-27T14:30:00Z", "level": "ERROR", "source": "AuthenticatieService", "message": "Gebruiker kon niet inloggen", "context": { "userID": "12345", "sessionID": "abcde-12345", "errorCode": "AUTH_FAILED" } } 11. Implementatievoorbeeld en instructies - Voorbeelden van correcte logregels - Integratie in bestaande systemen - Testen en validatie van logs 12. Documentatie en training - Richtlijnen voor ontwikkelaars en operators - Training- en awarenessprogramma’s Door deze onderdelen op te nemen in je documentatie zorg je voor een consistente basis voor alle logs binnen je organisatie. Het bevordert de efficiëntie bij monitoring, troubleshooting en naleving van regelgeving.

Zeker, hier is een gedetailleerde documentatie voor logstandaarden voor je ELK Stack, specifiek gericht op JSON-gestructureerde logs met ISO 8601 tijdstempels: --- ### **Documentatie: Logstandaarden voor ELK Stack** #### **1. Algemene Richtlijnen** - **Doel**: Zorg voor uniformiteit, leesbaarheid en efficiëntie in logverwerking. - **Formaat**: Gebruik uitsluitend **JSON** voor gestructureerde logging. - **Tijdstempel**: Houd je strikt aan **ISO 8601** (bijv. `2023-10-05T14:30:00.123Z`). - **Niveaus**: Gebruik standaard logniveaus: `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL`. --- #### **2. Verplichte Velden (Elke Logregel)** Iedere logentry moet deze velden bevatten: ```json { "timestamp": "2023-10-05T14:30:00.123Z", "level": "INFO", "message": "Beschrijving van de gebeurtenis", "service": "naam-van-de-service", "environment": "production" } ``` --- #### **3. Aanbevolen Velden (Contextuele Informatie)** Voeg optionele velden toe voor betere traceerbaarheid: ```json { "user_id": "gebruiker-123", "session_id": "sessie-abc", "correlation_id": "req-789", "http_method": "GET", "endpoint": "/api/data", "response_time_ms": 150, "error_code": "AUTH_FAILED" } ``` --- #### **4. Best Practices voor Consistentie** - **Tijdzone**: Gebruik **UTC** (aangegeven met `Z` in ISO 8601). - **Geneste Objecten**: Vermijd diepe geneste structuren; gebruik platte keys waar mogelijk. - **Dataformaten**: - Gebruik `string` voor tekst, `number` voor numerieke waarden, `boolean` voor true/false. - Behoud consistentie in veldnamen (bijv. `userId` of `user_id`, niet beide). - **Gevoelige Data**: Masker wachtwoorden, tokens of PII (Persoonlijk Identificeerbare Informatie). --- #### **5. Sjabloon voor Logentries** ```json { "timestamp": "2023-10-05T14:30:00.123Z", "level": "ERROR", "message": "Kan gebruikersgegevens niet ophalen", "service": "user-service", "environment": "staging", "correlation_id": "req-456", "user_id": "user-789", "http_status_code": 500, "stack_trace": "..." } ``` --- #### **6. Indexering in ELK** - **Index Pattern**: Gebruik een logische naam zoals `logs-{service}-{YYYY.MM.DD}`. - **Mapping**: Definieer datatypes in Elasticsearch voor velden zoals `timestamp` (als `date`) en `response_time_ms` (als `integer`). --- #### **7. Validatie en Handhaving** - **Tools**: Valideer logs met JSONLint of Elasticsearch Ingest Pipelines. - **Monitoring**: Stel alerts in voor afwijkingen (bijv. ontbrekende `timestamp`). - **Documentatie**: Houd een gedeelde wiki bij met veldbeschrijvingen en voorbeelden. --- #### **8. Voorbeeld van een Goede vs. Slechte Log** **Goed**: ```json { "timestamp": "2023-10-05T14:30:00.123Z", "level": "INFO", "message": "Gebruiker ingelogd", "service": "auth-service", "environment": "production", "user_id": "user-123" } ``` **Slecht**: ```json { "time": "5 Okt 2023 14:30", // Niet ISO 8601 "lvl": "info", // Inconsistente afkorting "msg": "Gebruiker ingelogd", "app": "auth" // Andere veldnaam } ``` --- Met deze richtlijnen garandeer je een robuust, onderhoudbaar en compliant logging-framework. Pas ze aan op basis van je specifieke use-cases en review ze regelmatig! 😊