Commit Graph

46 Commits

Author SHA1 Message Date
David Ashpole 93cb3d9447
typo 2024-03-26 17:23:04 +00:00
David Ashpole 9f043c9add
address feedback 2024-03-25 20:21:58 +00:00
David Ashpole 76c29a326d
add tracing instrumentation documentation 2024-03-25 20:04:01 +00:00
Aldo Culquicondor 1a09f12153
Add log message style guidelines 2023-03-31 08:54:45 -04:00
杨军10092085 d7ab088079 update migration-to-structured-logging.md 2022-06-24 06:05:45 +08:00
Kubernetes Prow Robot a858ed2d6d
Merge pull request #6565 from logicalhan/deprecate
add deprecation policy guidelines to instrumenting kubernetes guide
2022-04-27 10:24:11 -07:00
Patrick Ohly 94e8428298 logging: include information about contextual logging
In Kubernetes 1.24, the necessary infrastructure got added. Now developers can
take advantage of it.
2022-04-06 08:27:31 +02:00
Han Kang d03420721e add deprecation policy guidelines to instrumenting kubernetes guide 2022-03-25 08:34:06 -07:00
Kubernetes Prow Robot 28550696af
Merge pull request #6518 from ehashman/stable-metrics
Add metrics stability documentation from KEP-1209
2022-03-17 17:07:41 -07:00
Marek Siarkowicz e5eed38810 Update logging guidelines
Co-authored-by: Patrick Ohly <patrick.ohly@intel.com>
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2022-03-17 14:11:19 +01:00
Elana Hashman e2163b99c9
Add metrics stability documentation from KEP-1209 2022-03-03 10:39:18 -08:00
Marek Siarkowicz 1317bc799a Documment logging formats
Co-authored-by: Patrick Ohly <patrick.ohly@intel.com>
2021-12-01 12:10:07 +01:00
CatherineF-dev 0b66280b73 Update logging.md 2021-11-03 22:43:22 -04:00
CatherineF-dev e98dcfdbea move to logging.md 2021-11-03 22:41:16 -04:00
CatherineF-dev 8bc3ad39a2
Update contributors/devel/sig-instrumentation/migration-to-structured-logging.md
Co-authored-by: Madhav Jivrajani <12381034+MadhavJivrajani@users.noreply.github.com>
2021-11-03 14:01:51 +00:00
CatherineF-dev 24e42d0c10
Add logging header formats in doc
Add link for explaining logging header format `I1025 00:15:15.525108       1 controller_utils.go:116]`
2021-11-01 16:40:26 -04:00
CatherineF-dev ed3a7c4263
Refine sig-instrumentation devel docs (#5915)
* Updated sig-instrumentation devel docs

* klog.ErrorS example

Signed-off-by: Parul <parsingh@redhat.com>

* add os.Exit

Signed-off-by: Parul <parsingh@redhat.com>

Co-authored-by: Parul <parsingh@redhat.com>
2021-10-13 14:05:56 -07:00
Han Kang c5df2e6a9e amend instrumentation cardinality guidelines to explicitly call out namespaces 2021-07-29 08:11:47 -07:00
JunYang 298e0523f4 Add Information for Contributors
Signed-off-by: JunYang <yang.jun22@zte.com.cn>
2021-06-22 11:12:27 +08:00
Kubernetes Prow Robot 3d263582ff
Merge pull request #5803 from yangjunmyfm192085/community1
Support setting depth to structured logging
2021-05-31 07:58:27 -07:00
Marek Siarkowicz b1a40e14fb
Add serathius to devel reviewers and approvers 2021-05-30 15:43:02 +02:00
JunYang 25ca9642c9 Support setting depth to structured logging
Signed-off-by: JunYang <yang.jun22@zte.com.cn>
2021-05-30 21:16:55 +08:00
Han Kang ce96b836fa
Update instrumentation.md with current information
We don't allow the use of prometheus directly anymore, let's update the docs to reflect that.
2021-04-22 10:25:10 -07:00
Shiming Zhang 6334aa6c3a
Update contributors/devel/sig-instrumentation/migration-to-structured-logging.md
Co-authored-by: Elana Hashman <ehashman@users.noreply.github.com>
2021-04-09 09:58:25 +08:00
wzshiming d5f09dd23f Clear instructions for structured log migration 2021-04-08 09:49:24 +08:00
Saptarshi Majumder 96699f6d0b
doc_fix:Migrated to structured logging (#5624)
* doc_fix:Migrated to structured logging from non-stuctured logging

* doc_fix(update): More details added to each logger command

* doc_fix(update):Adding suggested doc changes
2021-03-25 08:47:29 -07:00
Kubernetes Prow Robot f3305857e7
Merge pull request #5492 from vorburger/patch-1
update logging guideline re. shared libraries
2021-02-24 09:24:50 -08:00
Marek Siarkowicz 034c8b18b2
Update instruction for naming arguments (#5537)
* Update instruction for naming arguments

* Apply suggestions from code review

Co-authored-by: Elana Hashman <ehashman@users.noreply.github.com>

* Update contributors/devel/sig-instrumentation/migration-to-structured-logging.md

Co-authored-by: Elana Hashman <ehashman@users.noreply.github.com>

* Update contributors/devel/sig-instrumentation/migration-to-structured-logging.md

Co-authored-by: Elana Hashman <ehashman@users.noreply.github.com>

Co-authored-by: Marek Siarkowicz <serathius@users.noreply.github.com>
Co-authored-by: Elana Hashman <ehashman@users.noreply.github.com>
2021-02-23 10:34:34 -08:00
Michael Vorburger ⛑️ befaff0f8f
Update logging guideline re. shared libraries 2021-02-12 19:06:54 +01:00
Elana Hashman 48a8c87b7e
Add guidance for fatal exit codes 2021-02-10 15:36:38 -08:00
Han Kang f7f69ff66a
Update instrumentation.md
Use prescribed naming conventions in the example for prescribed naming conventions.
2021-02-04 08:15:30 -08:00
chymy 038edf9b2e fix typo
Signed-off-by: chymy <chang.min1@zte.com.cn>
2021-02-02 10:58:15 +08:00
chymy f0c70180fe add 'go' for code
Signed-off-by: chymy <chang.min1@zte.com.cn>
2021-01-28 09:49:30 +08:00
chymy 8c193ef247 Fix klog.Infof change to klog.InfoS err
Signed-off-by: chymy <chang.min1@zte.com.cn>
2021-01-27 18:38:30 +08:00
David Ashpole e984f3b36d add reference to ksm 2020-12-15 11:25:58 -08:00
David Ashpole caecdf5a0e
Apply suggestions from code review
Co-authored-by: Tariq Ibrahim <tariq181290@gmail.com>
2020-12-15 13:07:25 -06:00
David Ashpole 89ed48f01e add exception for metric component prefixes for object metrics 2020-12-10 13:25:20 -08:00
Joseph Davis 4b94c80ba8 Trivial: code highlight for Event fields in style guide 2020-11-13 18:49:02 -08:00
Mickey Pashov 4eeba4d57b
Mention the new structured logging convention
As part of the structured logging migration It's probably worth having a line here for `InfoS()`
2020-10-03 20:08:21 +01:00
Marek Siarkowicz 5e71635bb6 Add instructions for structured logging migration
Co-authored-by: Md. Tahsin Rahman <tahsynx@gmail.com>
2020-06-03 16:03:43 +02:00
Frederic Branczyk 6a13552926
Update instrumentation.md 2019-09-09 14:27:42 +02:00
Frederic Branczyk 9dc669aedc
Update instrumentation.md 2019-09-09 13:27:18 +02:00
Nikhita Raghunath 354d724164 devel: add OWNERS files for sig sub-directories 2019-02-04 20:53:07 +05:30
eduartua f439e41460 file event-style-guide.md was moved to the new sig-instrumentation folder - URLs in k/community were updated 2019-01-28 14:59:09 -06:00
eduartua 9cfd840e1c file logging.md was moved to the new sig-instrumentation folder - URLs in k/community were updated 2019-01-28 14:45:07 -06:00
eduartua dd5f03ec49 created sig-instrumentation folder and file instrumentation.md was placed in - URLs in k/community were updated 2019-01-28 14:37:52 -06:00