Skip to content

Commit 209eb5d

Browse files
committed
Update README for v1.2.0
1 parent 1ad0fb0 commit 209eb5d

File tree

2 files changed

+18
-8
lines changed

2 files changed

+18
-8
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
PLUGIN_NAME=nanoandrew4/ngcplogs
2-
PLUGIN_TAG=v1.1.1
2+
PLUGIN_TAG=v1.2.0
33
PLUGIN_DIR=./ngcplogs-plugin
44
all: clean docker rootfs create
55
local: clean docker rootfs create enable

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
A modified version of the standard `gcplogs` docker logging driver. The standard `gcplogs` driver does not process the
66
output from the containers, which means JSON logs result in a log like this:
77

8+
<details>
9+
<summary>gcplogs sample log</summary>
10+
811
```json
912
{
1013
"insertId": "1x3kge4f3if919",
@@ -36,8 +39,13 @@ output from the containers, which means JSON logs result in a log like this:
3639
"receiveTimestamp": "2024-03-14T13:27:42.670937226Z"
3740
}
3841
```
42+
</details>
3943

4044
This driver behaves similarly to the `gcplogs` one, but if it detects a JSON log, it unmarshals it and sends the unmarshalled map as the payload, resulting in a log like this (with the default options):
45+
46+
<details>
47+
<summary>ngcplogs sample log</summary>
48+
4149
```json
4250
{
4351
"insertId": "yero77f8j919i9",
@@ -73,15 +81,17 @@ This driver behaves similarly to the `gcplogs` one, but if it detects a JSON log
7381
}
7482
```
7583

84+
</details>
85+
7686
Non JSON logs will not be processed, and will be sent to GCP as they were received, without being manipulated.
7787

7888
### Installation
7989

8090
```shell
81-
docker plugin install nanoandrew4/ngcplogs:v1.1.1 --grant-all-permissions
91+
docker plugin install nanoandrew4/ngcplogs:v1.2.0 --grant-all-permissions
8292
```
8393

84-
In your `daemon.json` file, change the `log-driver` to `nanoandrew4/ngcplogs:v1.1.1`, or just use the logging driver
94+
In your `daemon.json` file, change the `log-driver` to `nanoandrew4/ngcplogs:v1.2.0`, or just use the logging driver
8595
on specific containers instead of applying it globally.
8696

8797
If you have modified your `daemon.json` file, restart the daemon and docker services:
@@ -94,16 +104,16 @@ sudo systemctl daemon-reload && sudo systemctl restart docker
94104

95105
### Upgrading
96106
First stop all containers using the plugin. Once they are all stopped, run the following commands to upgrade from
97-
v1.1.0 to v1.1.1
107+
v1.1.1 to v1.2.0
98108

99109
```shell
100-
docker plugin disable nanoandrew4/ngcplogs:v1.1.0
101-
docker plugin rm nanoandrew4/ngcplogs:v1.1.0
102-
docker plugin install nanoandrew4/ngcplogs:v1.1.1 --grant-all-permissions
110+
docker plugin disable nanoandrew4/ngcplogs:v1.1.1
111+
docker plugin rm nanoandrew4/ngcplogs:v1.1.1
112+
docker plugin install nanoandrew4/ngcplogs:v1.2.0 --grant-all-permissions
103113
```
104114

105115
If you initially configured `ngcplogs` to be used globally in your `daemon.json` file, change the `log-driver` to
106-
`nanoandrew4/ngcplogs:v1.1.1`. Finally, restart the daemon and docker services:
116+
`nanoandrew4/ngcplogs:v1.2.0`. Finally, restart the daemon and docker services:
107117

108118
```shell
109119
sudo systemctl daemon-reload && sudo systemctl restart docker

0 commit comments

Comments
 (0)