summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoreduartua <eduartua@gmail.com>2019-01-28 14:45:07 -0600
committereduartua <eduartua@gmail.com>2019-01-28 14:45:07 -0600
commit9cfd840e1cd9376f562662dfe8135d3042a1e4cd (patch)
tree12b3c4cf3b0986493eb5a2694fbdacfcf7e191e4
parentdd5f03ec493bf9ac887ce83b1015751e5f1c7755 (diff)
file logging.md was moved to the new sig-instrumentation folder - URLs in k/community were updated
-rw-r--r--contributors/devel/README.md4
-rw-r--r--contributors/devel/instrumentation.md3
-rw-r--r--contributors/devel/logging.md35
-rw-r--r--contributors/devel/sig-instrumentation/logging.md34
-rw-r--r--contributors/guide/coding-conventions.md2
-rw-r--r--sig-instrumentation/charter.md2
6 files changed, 43 insertions, 37 deletions
diff --git a/contributors/devel/README.md b/contributors/devel/README.md
index 626adaad..e943a7a1 100644
--- a/contributors/devel/README.md
+++ b/contributors/devel/README.md
@@ -32,12 +32,12 @@ Guide](http://kubernetes.io/docs/admin/).
* **Hunting flaky tests** ([flaky-tests.md](flaky-tests.md)): We have a goal of 99.9% flake free tests.
Here's how to run your tests many times.
-* **Logging Conventions** ([logging.md](logging.md)): Glog levels.
+* **Logging Conventions** ([logging.md](sig-instrumentation/logging.md)): Glog levels.
* **Profiling Kubernetes** ([profiling.md](profiling.md)): How to plug in go pprof profiler to Kubernetes.
* **Instrumenting Kubernetes with a new metric**
- ([instrumentation.md](instrumentation.md)): How to add a new metrics to the
+ ([instrumentation.md](sig-instrumentation/instrumentation.md)): How to add a new metrics to the
Kubernetes code base.
* **Coding Conventions** ([coding-conventions.md](../guide/coding-conventions.md)):
diff --git a/contributors/devel/instrumentation.md b/contributors/devel/instrumentation.md
new file mode 100644
index 00000000..110359b2
--- /dev/null
+++ b/contributors/devel/instrumentation.md
@@ -0,0 +1,3 @@
+This file has moved to https://git.k8s.io/community/contributors/devel/sig-instrumentation/instrumentation.md.
+
+This file is a placeholder to preserve links. Please remove by April 28, 2019 or the release of kubernetes 1.13, whichever comes first. \ No newline at end of file
diff --git a/contributors/devel/logging.md b/contributors/devel/logging.md
index c4da6829..d857bc64 100644
--- a/contributors/devel/logging.md
+++ b/contributors/devel/logging.md
@@ -1,34 +1,3 @@
-## Logging Conventions
+This file has moved to https://git.k8s.io/community/contributors/devel/sig-instrumentation/logging.md.
-The following conventions for the klog levels to use.
-[klog](http://godoc.org/github.com/kubernetes/klog) is globally preferred to
-[log](http://golang.org/pkg/log/) for better runtime control.
-
-* klog.Errorf() - Always an error
-
-* klog.Warningf() - Something unexpected, but probably not an error
-
-* klog.Infof() has multiple levels:
- * klog.V(0) - Generally useful for this to ALWAYS be visible to an operator
- * Programmer errors
- * Logging extra info about a panic
- * CLI argument handling
- * klog.V(1) - A reasonable default log level if you don't want verbosity.
- * Information about config (listening on X, watching Y)
- * Errors that repeat frequently that relate to conditions that can be corrected (pod detected as unhealthy)
- * klog.V(2) - Useful steady state information about the service and important log messages that may correlate to significant changes in the system. This is the recommended default log level for most systems.
- * Logging HTTP requests and their exit code
- * System state changing (killing pod)
- * Controller state change events (starting pods)
- * Scheduler log messages
- * klog.V(3) - Extended information about changes
- * More info about system state changes
- * klog.V(4) - Debug level verbosity
- * Logging in particularly thorny parts of code where you may want to come back later and check it
- * klog.V(5) - Trace level verbosity
- * Context to understand the steps leading up to errors and warnings
- * More information for troubleshooting reported issues
-
-As per the comments, the practical default level is V(2). Developers and QE
-environments may wish to run at V(3) or V(4). If you wish to change the log
-level, you can pass in `-v=X` where X is the desired maximum level to log.
+This file is a placeholder to preserve links. Please remove by April 28, 2019 or the release of kubernetes 1.13, whichever comes first. \ No newline at end of file
diff --git a/contributors/devel/sig-instrumentation/logging.md b/contributors/devel/sig-instrumentation/logging.md
new file mode 100644
index 00000000..c4da6829
--- /dev/null
+++ b/contributors/devel/sig-instrumentation/logging.md
@@ -0,0 +1,34 @@
+## Logging Conventions
+
+The following conventions for the klog levels to use.
+[klog](http://godoc.org/github.com/kubernetes/klog) is globally preferred to
+[log](http://golang.org/pkg/log/) for better runtime control.
+
+* klog.Errorf() - Always an error
+
+* klog.Warningf() - Something unexpected, but probably not an error
+
+* klog.Infof() has multiple levels:
+ * klog.V(0) - Generally useful for this to ALWAYS be visible to an operator
+ * Programmer errors
+ * Logging extra info about a panic
+ * CLI argument handling
+ * klog.V(1) - A reasonable default log level if you don't want verbosity.
+ * Information about config (listening on X, watching Y)
+ * Errors that repeat frequently that relate to conditions that can be corrected (pod detected as unhealthy)
+ * klog.V(2) - Useful steady state information about the service and important log messages that may correlate to significant changes in the system. This is the recommended default log level for most systems.
+ * Logging HTTP requests and their exit code
+ * System state changing (killing pod)
+ * Controller state change events (starting pods)
+ * Scheduler log messages
+ * klog.V(3) - Extended information about changes
+ * More info about system state changes
+ * klog.V(4) - Debug level verbosity
+ * Logging in particularly thorny parts of code where you may want to come back later and check it
+ * klog.V(5) - Trace level verbosity
+ * Context to understand the steps leading up to errors and warnings
+ * More information for troubleshooting reported issues
+
+As per the comments, the practical default level is V(2). Developers and QE
+environments may wish to run at V(3) or V(4). If you wish to change the log
+level, you can pass in `-v=X` where X is the desired maximum level to log.
diff --git a/contributors/guide/coding-conventions.md b/contributors/guide/coding-conventions.md
index 63cc18ce..ebabbcbf 100644
--- a/contributors/guide/coding-conventions.md
+++ b/contributors/guide/coding-conventions.md
@@ -61,7 +61,7 @@ following Go conventions - `stateLock`, `mapLock` etc.
- [Kubectl conventions](/contributors/devel/kubectl-conventions.md)
- - [Logging conventions](/contributors/devel/logging.md)
+ - [Logging conventions](/contributors/devel/sig-instrumentation/logging.md)
## Testing conventions
diff --git a/sig-instrumentation/charter.md b/sig-instrumentation/charter.md
index d767a706..b5cd7643 100644
--- a/sig-instrumentation/charter.md
+++ b/sig-instrumentation/charter.md
@@ -69,5 +69,5 @@ By SIG Technical Leads
[sig-node]: https://github.com/kubernetes/community/tree/master/sig-node
[sigs.yaml]: https://github.com/kubernetes/community/blob/master/sigs.yaml#L964-L1018
[Kubernetes Charter README]: https://github.com/kubernetes/community/blob/master/committee-steering/governance/README.md
-[instrumenting-kubernetes]: https://github.com/kubernetes/community/blob/master/contributors/devel/instrumentation.md
+[instrumenting-kubernetes]: /contributors/devel/sig-instrumentation/instrumentation.md
[core-metrics-pipeline]: https://kubernetes.io/docs/tasks/debug-application-cluster/core-metrics-pipeline/