Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 2 additions & 11 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,19 +27,10 @@ repos:
docker-compose.*|\
.pre-commit-config.yaml|\
orchestration-canary-alarms.template.yaml|\
.*.approved.json|\
checkov-policies.*|\
.terraform-docs.yml|\
package.json|\
deprecation-config.json|\
http-client.env.json|\
package-lock.json|\
.*provider.json|\
quality-gate.manifest.json|\
account-management-api/api-contract(/.*)?|\
babel.config.json|\
jest.config.json$"
files: ^.*\.(json|yml|yaml)$
account-management-api/api-contract(/.*)?$"
files: ^.*\.(yml|yaml)$

- repo: https://github.com/govuk-one-login/pre-commit-hooks.git
rev: 0.0.1
Expand Down
75 changes: 75 additions & 0 deletions account-management-api/src/main/resources/LambdaJsonLayout.json
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general this is based on https://github.com/apache/logging-log4j2/blob/rel/2.25.2/log4j-layout-template-json/src/main/resources/JsonLayout.json which mimics the output of JsonLayout.

We don't have to keep this - some things to consider:

  • Changing the timestamp format to ISO-8601 for readability
  • Removing client-session-id (if it's always the same as govuk_journey_id)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd want to double check we are definitely setting the journey id everywhere - I'm pretty sure we are, but the team mostly currently rely on client-session-id for querying logs so there's a small chance it's not been added somewhere

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool - I'll probably leave it in for now, and let you tweak further as you like, hopefully it's fairly obvious how to update the config to do that!

(This specific file doesn't have it - because it's not logged in acct management API, but it should still be present in all the orch stuff)

Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
{
"instant": {
"epochSecond": {
"$resolver": "timestamp",
"epoch": {
"unit": "secs",
"rounded": true
}
},
"nanoOfSecond": {
"$resolver": "timestamp",
"epoch": {
"unit": "secs.nanos"
}
}
},
"level": {
"$resolver": "level",
"field": "name"
},
"loggerName": {
"$resolver": "logger",
"field": "name"
},
"message": {
"$resolver": "message"
},
"thrown": {
"message": {
"$resolver": "exception",
"field": "message"
},
"name": {
"$resolver": "exception",
"field": "className"
},
"extendedStackTrace": {
"$resolver": "exception",
"field": "stackTrace"
}
},
"contextStack": {
"$resolver": "ndc"
},
"source": {
"class": {
"$resolver": "source",
"field": "className"
},
"method": {
"$resolver": "source",
"field": "methodName"
},
"file": {
"$resolver": "source",
"field": "fileName"
},
"line": {
"$resolver": "source",
"field": "lineNumber"
}
},
"session-id": {
"$resolver": "mdc",
"key": "sessionId"
},
"aws-request-id": {
"$resolver": "mdc",
"key": "awsRequestId"
},
"trace-id": {
"$resolver": "mdc",
"key": "traceId"
}
}
6 changes: 1 addition & 5 deletions account-management-api/src/main/resources/log4j2.xml
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
<Configuration status="WARN">
<Appenders>
<Lambda name="Lambda">
<JsonLayout compact="true" eventEol="true" objectMessageAsJsonObject="true" >
<KeyValuePair key="session-id" value="$${ctx:sessionId:-unknown}"/>
<KeyValuePair key="aws-request-id" value="$${ctx:awsRequestId:-}"/>
<KeyValuePair key="trace-id" value="$${ctx:traceId:-}"/>
</JsonLayout>
<JsonTemplateLayout eventTemplateUri="classpath:LambdaJsonLayout.json" />
</Lambda>
</Appenders>
<Loggers>
Expand Down
75 changes: 75 additions & 0 deletions auth-external-api/src/main/resources/LambdaJsonLayout.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
{
"instant": {
"epochSecond": {
"$resolver": "timestamp",
"epoch": {
"unit": "secs",
"rounded": true
}
},
"nanoOfSecond": {
"$resolver": "timestamp",
"epoch": {
"unit": "secs.nanos"
}
}
},
"level": {
"$resolver": "level",
"field": "name"
},
"loggerName": {
"$resolver": "logger",
"field": "name"
},
"message": {
"$resolver": "message"
},
"thrown": {
"message": {
"$resolver": "exception",
"field": "message"
},
"name": {
"$resolver": "exception",
"field": "className"
},
"extendedStackTrace": {
"$resolver": "exception",
"field": "stackTrace"
}
},
"contextStack": {
"$resolver": "ndc"
},
"source": {
"class": {
"$resolver": "source",
"field": "className"
},
"method": {
"$resolver": "source",
"field": "methodName"
},
"file": {
"$resolver": "source",
"field": "fileName"
},
"line": {
"$resolver": "source",
"field": "lineNumber"
}
},
"session-id": {
"$resolver": "mdc",
"key": "sessionId"
},
"aws-request-id": {
"$resolver": "mdc",
"key": "awsRequestId"
},
"trace-id": {
"$resolver": "mdc",
"key": "traceId"
}
}
5 changes: 1 addition & 4 deletions auth-external-api/src/main/resources/log4j2.xml
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
<Configuration status="WARN">
<Appenders>
<Lambda name="Lambda">
<JsonLayout compact="true" eventEol="true" objectMessageAsJsonObject="true" >
<KeyValuePair key="session-id" value="$${ctx:sessionId:-unknown}"/>
<KeyValuePair key="trace-id" value="$${ctx:traceId:-}"/>
</JsonLayout>
<JsonTemplateLayout eventTemplateUri="classpath:LambdaJsonLayout.json" />
</Lambda>
</Appenders>
<Loggers>
Expand Down
75 changes: 75 additions & 0 deletions client-registry-api/src/main/resources/LambdaJsonLayout.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
{
"instant": {
"epochSecond": {
"$resolver": "timestamp",
"epoch": {
"unit": "secs",
"rounded": true
}
},
"nanoOfSecond": {
"$resolver": "timestamp",
"epoch": {
"unit": "secs.nanos"
}
}
},
"level": {
"$resolver": "level",
"field": "name"
},
"loggerName": {
"$resolver": "logger",
"field": "name"
},
"message": {
"$resolver": "message"
},
"thrown": {
"message": {
"$resolver": "exception",
"field": "message"
},
"name": {
"$resolver": "exception",
"field": "className"
},
"extendedStackTrace": {
"$resolver": "exception",
"field": "stackTrace"
}
},
"contextStack": {
"$resolver": "ndc"
},
"source": {
"class": {
"$resolver": "source",
"field": "className"
},
"method": {
"$resolver": "source",
"field": "methodName"
},
"file": {
"$resolver": "source",
"field": "fileName"
},
"line": {
"$resolver": "source",
"field": "lineNumber"
}
},
"session-id": {
"$resolver": "mdc",
"key": "sessionId"
},
"aws-request-id": {
"$resolver": "mdc",
"key": "awsRequestId"
},
"trace-id": {
"$resolver": "mdc",
"key": "traceId"
}
}
5 changes: 1 addition & 4 deletions client-registry-api/src/main/resources/log4j2.xml
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
<Configuration status="WARN">
<Appenders>
<Lambda name="Lambda">
<JsonLayout compact="true" eventEol="true" objectMessageAsJsonObject="true" >
<KeyValuePair key="session-id" value="$${ctx:sessionId:-unknown}"/>
<KeyValuePair key="trace-id" value="$${ctx:traceId:-}"/>
</JsonLayout>
<JsonTemplateLayout eventTemplateUri="classpath:LambdaJsonLayout.json" />
</Lambda>
</Appenders>
<Loggers>
Expand Down
83 changes: 83 additions & 0 deletions delivery-receipts-api/src/main/resources/LambdaJsonLayout.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
{
"instant": {
"epochSecond": {
"$resolver": "timestamp",
"epoch": {
"unit": "secs",
"rounded": true
}
},
"nanoOfSecond": {
"$resolver": "timestamp",
"epoch": {
"unit": "secs.nanos"
}
}
},
"level": {
"$resolver": "level",
"field": "name"
},
"loggerName": {
"$resolver": "logger",
"field": "name"
},
"message": {
"$resolver": "message"
},
"thrown": {
"message": {
"$resolver": "exception",
"field": "message"
},
"name": {
"$resolver": "exception",
"field": "className"
},
"extendedStackTrace": {
"$resolver": "exception",
"field": "stackTrace"
}
},
"contextStack": {
"$resolver": "ndc"
},
"source": {
"class": {
"$resolver": "source",
"field": "className"
},
"method": {
"$resolver": "source",
"field": "methodName"
},
"file": {
"$resolver": "source",
"field": "fileName"
},
"line": {
"$resolver": "source",
"field": "lineNumber"
}
},
"notification-id": {
"$resolver": "mdc",
"key": "notificationId"
},
"unique-notification-reference": {
"$resolver": "mdc",
"key": "uniqueNotificationReference"
},
"govuk_signin_journey_id": {
"$resolver": "mdc",
"key": "govukSigninJourneyId"
},
"aws-request-id": {
"$resolver": "mdc",
"key": "awsRequestId"
},
"trace-id": {
"$resolver": "mdc",
"key": "traceId"
}
}
7 changes: 1 addition & 6 deletions delivery-receipts-api/src/main/resources/log4j2.xml
Original file line number Diff line number Diff line change
@@ -1,12 +1,7 @@
<Configuration status="WARN">
<Appenders>
<Lambda name="Lambda">
<JsonLayout compact="true" eventEol="true" objectMessageAsJsonObject="true" >
<KeyValuePair key="notification-id" value="$${ctx:notificationId:-unknown}"/>
<KeyValuePair key="unique-notification-reference" value="$${ctx:uniqueNotificationReference:-unknown}"/>
<KeyValuePair key="govuk_signin_journey_id" value="$${ctx:journeyId:-unknown}"/>
<KeyValuePair key="trace-id" value="$${ctx:traceId:-}"/>
</JsonLayout>
<JsonTemplateLayout eventTemplateUri="classpath:LambdaJsonLayout.json" />
</Lambda>
</Appenders>
<Loggers>
Expand Down
Loading
Loading