adds doc comments to metrics methods

tektoncd · Oct 16, 2019 · 24afa9b · 24afa9b
1 parent 9c1cea6
commit 24afa9b
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 4 deletions.
diff --git a/pkg/reconciler/pipelinerun/metrics.go b/pkg/reconciler/pipelinerun/metrics.go
@@ -41,6 +41,9 @@ type Recorder struct {
 	status      tag.Key
 }
 
+
+// NewRecorder creates a new metrics recorder instance
+// to log the PipelineRun related metrics
 func NewRecorder() (*Recorder, error) {
 	r := &Recorder{
 		initialized: true,
@@ -98,6 +101,9 @@ func NewRecorder() (*Recorder, error) {
 	return r, nil
 }
 
+// DurationAndCount logs the duration of PipelineRun execution and
+// count for number of PipelineRuns succeed or failed
+// returns an error if its failed to log the metrics
 func (r *Recorder) DurationAndCount(pr *v1alpha1.PipelineRun) error {
 	if !r.initialized {
 		return fmt.Errorf("ignoring the metrics recording for %s , failed to initialize the metrics recorder", pr.Name)
@@ -131,6 +137,8 @@ func (r *Recorder) DurationAndCount(pr *v1alpha1.PipelineRun) error {
 	return nil
 }
 
+// RunningPipelineRuns logs the number of PipelineRuns running right now
+// returns an error if its failed to log the metrics
 func (r *Recorder) RunningPipelineRuns(lister listers.PipelineRunLister) error {
 	if !r.initialized {
 		return errors.New("ignoring the metrics recording, failed to initialize the metrics recorder")

diff --git a/pkg/reconciler/taskrun/metrics.go b/pkg/reconciler/taskrun/metrics.go
@@ -55,8 +55,8 @@ type Recorder struct {
 	pod         tag.Key
 }
 
-//NewRecorder creates a new instance of metrics recorder to
-//to log the TaskRun related metrics
+// NewRecorder creates a new metrics recorder instance 
+// to log the TaskRun related metrics
 func NewRecorder() (*Recorder, error) {
 	r := &Recorder{
 		initialized: true,
@@ -144,8 +144,9 @@ func NewRecorder() (*Recorder, error) {
 	return r, nil
 }
 
-//DurationAndCount logs the duration of TaskRun execution and
-//count for number of TaskRuns succeed or failed
+// DurationAndCount logs the duration of TaskRun execution and
+// count for number of TaskRuns succeed or failed
+// returns an error if its failed to log the metrics
 func (r *Recorder) DurationAndCount(tr *v1alpha1.TaskRun) error {
 	if !r.initialized {
 		return fmt.Errorf("ignoring the metrics recording for %s , failed to initialize the metrics recorder", tr.Name)
@@ -203,6 +204,8 @@ func (r *Recorder) DurationAndCount(tr *v1alpha1.TaskRun) error {
 	return nil
 }
 
+// RunningTaskRuns logs the number of TaskRuns running right now
+// returns an error if its failed to log the metrics
 func (r *Recorder) RunningTaskRuns(lister listers.TaskRunLister) error {
 	if !r.initialized {
 		return errors.New("ignoring the metrics recording, failed to initialize the metrics recorder")
@@ -231,6 +234,8 @@ func (r *Recorder) RunningTaskRuns(lister listers.TaskRunLister) error {
 	return nil
 }
 
+// RecordPodLatency logs the duration required to schedule the pod for TaskRun
+// returns an error if its failed to log the metrics
 func (r *Recorder) RecordPodLatency(pod *corev1.Pod, tr *v1alpha1.TaskRun) error {
 	if !r.initialized {
 		return errors.New("ignoring the metrics recording for pod , failed to initialize the metrics recorder")