chore: fixing descriptions

open-telemetry · Dec 10, 2020 · 33329e1 · 33329e1
1 parent 1739685
commit 33329e1
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 9 deletions.
diff --git a/packages/opentelemetry-host-metrics/src/BaseMetrics.ts b/packages/opentelemetry-host-metrics/src/BaseMetrics.ts
@@ -44,9 +44,7 @@ const DEFAULT_METRIC_NAME_SEPARATOR = '.';
 const DEFAULT_KEY = 'name';
 
 /**
- * Metrics Collector - collects metrics for CPU, Memory, Heap, Network, Event
- * Loop, Garbage Collector, Heap Space
- * the default label name for metric name is "name"
+ * Base Class for metrics
  */
 export abstract class BaseMetrics {
   protected _logger: api.Logger | undefined;

diff --git a/packages/opentelemetry-host-metrics/src/metric.ts b/packages/opentelemetry-host-metrics/src/metric.ts
@@ -22,12 +22,8 @@ import { getCpuUsageData, getMemoryData } from './stats/common';
 import { getNetworkData } from './stats/si';
 import { CpuUsageData, MemoryData, NetworkData } from './types';
 
-// import * as types from './types';
-
 /**
- * Metrics Collector - collects metrics for CPU, Memory, Heap, Network, Event
- * Loop, Garbage Collector, Heap Space
- * the default label name for metric name is "name"
+ * Metrics Collector - collects metrics for CPU, Memory, Network
  */
 export class HostMetrics extends BaseMetrics {
   private _cpuTimeObserver!: api.SumObserver;
@@ -244,7 +240,7 @@ export class HostMetrics extends BaseMetrics {
   }
 
   /**
-   * Starts collecting stats
+   * Starts collecting metrics
    */
   start() {
     // initial collection