Skip to content

Commit 6246c76

Browse files
authored
Merge pull request kubernetes#2511 from navidshaikh/pr/fix-typo
Fix typos in structured logging KEP README
2 parents 38f1492 + 192709b commit 6246c76

File tree

1 file changed

+5
-5
lines changed
  • keps/sig-instrumentation/1602-structured-logging

1 file changed

+5
-5
lines changed

keps/sig-instrumentation/1602-structured-logging/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -381,8 +381,8 @@ Introduce structured logging and JSON format:
381381
Bring feature quality up to and prevent regression during ongoing migration:
382382
* Directories can be marked as migrated, preventing regression via verify script in `hack`.
383383
* [Kubernetes Logging documentation](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/logging.md) is updated for structured logging.
384-
* Json format should support same set of feature flags as text format, minus those we will decide to deprecte.
385-
* Structured logging interface design is verify by migrating one whole component (Kubelet) to structured logging. All other component migrations will be best effort.
384+
* JSON format should support same set of feature flags as text format, minus those we will decide to deprecate.
385+
* Structured logging interface design is verified by migrating one whole component (Kubelet) to structured logging. All other component migrations will be best effort.
386386

387387
#### GA
388388

@@ -417,7 +417,7 @@ For json format we used [zap](https://github.com/uber-go/zap).
417417

418418
Changes in format presented in this KEP will result in adding additional metadata to logs, potentially largely increasing log volume.
419419
Unexpected log volume increase can lead to performance problems due exhausting disk IO or halting whole process when logs cannot be written on full disk.
420-
To avoid breaking existing poduction clusters we would like to target of around 10% of log volume increase between kubernetes versions (proposed by @wojtekt).
420+
To avoid breaking existing production clusters we would like to target of around 10% of log volume increase between kubernetes versions (proposed by @wojtekt).
421421

422422
During log volume analysis we would like to mainly focus on Kubernetes apiserver HTTP access logs. Those logs will have biggest impact
423423
* They are responsible for 85% of log volume generated in cluster
@@ -443,7 +443,7 @@ Resulting log line is 248 characters long. Additional 42 characters has resulted
443443
I0129 03:30:57.673664 1 httplog.go:90] verb="GET" URI="/api/v1/namespaces/kube-system/pods/metrics-server-v0.3.1-57c75779f-9p8wg" latency=1.512ms resp=200 UserAgent="kubelet/v1.18.0 (linux/amd64) kubernetes/15c3f1b" srcIP="10.56.1.19:51756":
444444
```
445445

446-
For migration to structured api we would like to propose to remove `statusStack` and `addedInfo` arguments. Our reasons:
446+
For migration to structured API we would like to propose to remove `statusStack` and `addedInfo` arguments. Our reasons:
447447
* Log format already neglects to put metadata for them, breaking the convention.
448448
* We didn't find any case of those fields being non empty in [gce-master-scale-performance](https://k8s-testgrid.appspot.com/sig-scalability-gce#gce-master-scale-performance)
449449

@@ -707,7 +707,7 @@ previous answers based on experience in the field._
707707
Log volume increase analysis discussed in [Log volume increase analysis] section.
708708
Expected increase on level of 4% which is considered acceptable by sig scalability.
709709

710-
Peformance was discussed in [Logger implementation performance] section.
710+
Performance was discussed in [Logger implementation performance] section.
711711
InfoS implementation for text is 9% slower than Infof.
712712
This increase should not have a big impact on overall Kubernetes performance
713713
as logging takes less than 2% of overall CPU usage

0 commit comments

Comments
 (0)