chore(logs): add comments

experimental/packages/api-logs/test/api/api.test.ts

@@ -16,7 +16,8 @@
 
 import * as assert from "assert";
 
-import { Logger, logs } from "../../src";
+import type { Logger } from "../../src";
+import { logs } from "../../src";
 import { NoopLogger } from "../../src/NoopLogger";
 import { NoopLoggerProvider } from "../../src/NoopLoggerProvider";
 

experimental/packages/exporter-logs-otlp-http/src/platform/config.ts

@@ -14,12 +14,9 @@
  * limitations under the License.
  */
 
+import type { OTLPExporterConfigBase } from '@opentelemetry/otlp-exporter-base';
 import { getEnv } from "@opentelemetry/core";
-import {
-  appendResourcePathToUrl,
-  appendRootPathToUrlIfNeeded,
-  OTLPExporterConfigBase,
-} from "@opentelemetry/otlp-exporter-base";
+import { appendResourcePathToUrl, appendRootPathToUrlIfNeeded } from "@opentelemetry/otlp-exporter-base";
 
 const DEFAULT_COLLECTOR_RESOURCE_PATH = "v1/logs";
 export const DEFAULT_COLLECTOR_URL = `http://localhost:4318/${DEFAULT_COLLECTOR_RESOURCE_PATH}`;

experimental/packages/otlp-transformer/src/logs/internal.ts

@@ -19,9 +19,9 @@ import type { ReadableLogRecord } from "@opentelemetry/sdk-logs";
 import { hrTimeToNanoseconds } from "@opentelemetry/core";
 
 import type { IResource } from "../resource/types";
+import type { IScopeLogs, ILogRecord, IResourceLogs } from "./types";
 import { toAnyValue, toAttributes } from "../common/internal";
 
-import type { IScopeLogs, ILogRecord, IResourceLogs } from "./types";
 
 type ResourceMapValue = Map<string, ReadableLogRecord[]>;
 

experimental/packages/sdk-logs/README.md

@@ -88,4 +88,4 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
 [license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/main/LICENSE
 [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
 [npm-url]: https://www.npmjs.com/package/@opentelemetry/sdk-logs
-[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fmetrics.svg
+[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Flogs.svg

experimental/packages/sdk-logs/src/Logger.ts

@@ -32,6 +32,7 @@ export class Logger implements logsAPI.Logger {
     this._loggerSharedState = config.loggerSharedState;
     this._instrumentationScope = config.instrumentationScope;
   }
+
   /**
    * Get a new {@link LogRecord} instance
    *

experimental/packages/sdk-logs/src/LoggerProvider.ts

@@ -69,9 +69,8 @@ export class LoggerProvider implements logsAPI.LoggerProvider {
   }
 
   /**
-   * Notifies all registered LogRecordProcessor to flush any buffered data.
-   *
-   * Returns a promise which is resolved when all flushes are complete.
+   * Notifies all registered {@link LogRecordProcessor} to flush any buffered data.
+   * @returns Returns a promise which is resolved when all flushes are complete.
    */
   public forceFlush(): Promise<void> {
     if (this._shutdownOnceFeature.isCalled) {

experimental/packages/sdk-logs/src/export/SimpleLogRecordProcessor.ts

@@ -36,7 +36,7 @@ export class SimpleLogRecordProcessor implements LogRecordProcessor {
   }
 
   public forceFlush(): Promise<void> {
-    // do nothing as all spans are being exported without waiting
+    // do nothing as all logs are being exported without waiting
     return Promise.resolve();
   }
 

experimental/packages/sdk-logs/src/types.ts

@@ -21,7 +21,7 @@ import type { LogRecordOptions } from "@opentelemetry/api-logs";
 import type { LoggerSharedState } from "./LoggerSharedState";
 
 export interface LoggerProviderConfig {
-  /** Resource associated with trace telemetry  */
+  /** Resource associated with log telemetry  */
   resource?: Resource;
 
   /** Log Record Limits*/

experimental/packages/sdk-logs/test/common/utils.ts

@@ -26,7 +26,7 @@ export const validAttributes = {
 export const invalidAttributes = {
   // invalid attribute type object
   object: { foo: "bar" },
-  // invalid attribute inhomogenous array
+  // invalid attribute inhomogeneous array
   "non-homogeneous-array": [0, ""],
   // This empty length attribute should not be set
   "": "empty-key",