API Usage & Best Practices
1. Introduction
- Short presentation of EVENT-STORE.
- Main goal: centralize, normalize, and analyze events to track resources and services efficiently.
- Key benefits: time saving, structured analysis, and clear communication of events.
2. Data Structure in EVENT-STORE
2.1 Client Information
-
cl – Client name.
- Example: "MyCompany"
-
hs – Hyperscaler.
- Possible values: AWS, GCP, AZU, CAV.
- Example: "AWS"
-
ac – Account number or logical account name.
- Examples: "525060831330" or "PRODUCTION"
-
re – Resource or service region.
- Example: "eu-west-3"
2.2 Event Information
-
ty – Event type.
- Must be explicit and clear in a few words.
- Examples: "START EC2", "PB BACKUP", "EC2 DISK SPACE".
-
st – Event status.
- Possible values: OK, KO, PR (or any two-letter code).
- Example: "KO"
-
im – Event impact.
- Possible values: MINOR, MODERATE, MAJOR, CRITICAL.
- Example: "MAJOR"
2.3 Nature of the Issue
-
me – Human-readable message linked to the type and status.
- Example: "Backup failed for instance ID xyz."
-
us_* – Custom fields for additional context.
- Examples: "us_application=MyApp", "us_environment=Prod".
3. Event Presentation
3.1 Executive Summary
- Should always include: cl, hs, ac, re.
- Example of a structured JSON payload:
{
"cl": "MyCompany",
"hs": "AWS",
"ac": "525060831330",
"re": "eu-west-3"
}
3.2 Event Overview & Context
- Key fields: ty, st, im.
- Example of a quick display:
- Event type: PB BACKUP
- Status: KO
- Impact: MAJOR
3.3 Purpose & Goal of the Event
- Combine: ty, st, im, me.
- Explain clearly why the event matters and its potential impact.
3.4 Highlights
- Focus on key points based on ty and st.
- Example:
- Event: START EC2
- Status: OK
3.5 Resource Profile
- Use custom fields us_* to describe the resource context.
- Example:
- us_application=WebApp
- us_environment=Staging
3.6 Engagement & Interactions
- Reflect user impact and technical actions using me and us_*.
- Example:
- Message: "Auto-scaling triggered successfully."
- Affected application: "MyApp"
3.7 Event Summary
- Provide a concise synthetic description of the situation based on me.
- Example:
Backup failed on eu-west-3 due to insufficient disk space. Action required.
3.8 Strategy & Next Steps
- Propose actions or remediation based on me and im.
- Example:
Critical issue identified. Initiate backup cleanup and increase storage capacity to prevent recurrence.
4. Examples of Best Practices
4.1 Data Formatting
- Always fill the core fields: cl, ty, st, im, me.
- Example:
{
"cl": "MyCompany",
"hs": "AWS",
"ty": "PB BACKUP",
"st": "KO",
"im": "CRITICAL",
"me": "Backup failed due to disk space."
}
4.2 Smart Use of Custom Fields
- Add contextual details with us_* fields.
- Examples:
- us_application=MyApp
- us_team=DevOps
5. Tips for Event Management
- Simplicity: keep event types (ty) short and explicit.
- Clarity: use standardized statuses (st) to simplify reporting and dashboards.
- Customization: leverage us_* fields to adapt to client-specific needs.
- Prioritization: highlight events with impact MAJOR or CRITICAL in your alerts and views.