gchq / gchq/event-logging-schema

Add TimeReceived and TimeEnded to EventTime element

Open
#41 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement non-breaking-change
Dominant language
Shell
Stars
25
Forks
6
PR merge metrics
No merged PRs in 30d

Description

Sometimes events are received well after when there were created. The addition of a TimeReceived element can record when the event was received by the Event Repository (e.g Stroom proxy, Stroom Application, Syslog server, etc).

Some events have a duration as opposed to just a single point in time. The addition of a TimeEnded element can record when such events ended. (E.G. Connection events)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the EventTime element in the event-logging XML Schema and reviewing how existing event timestamps are represented. Check the examples in the issue, including receipt by an Event Repository and the end of connection events. Done means the schema defines TimeReceived and TimeEnded with semantics that support those cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
xml
Domain
backend-api-design
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.