Type Alias Telemetry

type Telemetry = {
    deleteTelemetry(
        exporterId?: string,
        category?: TelemetryExporterCategory,
    ): Promise<LogExporterSkeleton[]>;
    exportTelemetry(
        exporterId?: string,
        category?: TelemetryExporterCategory,
    ): Promise<TelemetryExportInterface>;
    importTelemetry(
        importData: TelemetryExportInterface,
        exporterId?: string,
        category?: TelemetryExporterCategory,
    ): Promise<LogExporterSkeleton[]>;
    readTelemetry(): Promise<TelemetryExporters>;
    updateTelemetry(
        category: TelemetryExporterCategory,
        exporterId: string,
        exporterData: LogExporterSkeleton,
    ): Promise<LogExporterSkeleton>;
}

Index

Methods

deleteTelemetry exportTelemetry importTelemetry readTelemetry updateTelemetry

Methods

deleteTelemetry

deleteTelemetry(
exporterId?: string,
category?: TelemetryExporterCategory,
): Promise<LogExporterSkeleton[]>
Delete telemetry exporters
Parameters
- OptionalexporterId: string
  optional exporter id; if provided, only deletes the specified exporter
- Optionalcategory: TelemetryExporterCategory
  optional exporter category; if provided, only deletes exporters in the specified category
Returns Promise<LogExporterSkeleton[]>
- Defined in ops/cloud/TelemetryOps.ts:66

exportTelemetry

exportTelemetry(
exporterId?: string,
category?: TelemetryExporterCategory,
): Promise<TelemetryExportInterface>
Export telemetry exporters, optionally filtered by id and/or category
Parameters
- OptionalexporterId: string
  optional exporter id to filter by
- Optionalcategory: TelemetryExporterCategory
  optional category to filter by
Returns Promise<TelemetryExportInterface>
a promise resolving to a TelemetryExportInterface object
- Defined in ops/cloud/TelemetryOps.ts:32

importTelemetry

importTelemetry(
    importData: TelemetryExportInterface,
    exporterId?: string,
    category?: TelemetryExporterCategory,
): Promise<LogExporterSkeleton[]>
Import telemetry exporters
Parameters
- importData: TelemetryExportInterface
  telemetry import data
- OptionalexporterId: string
  optional exporter id; if provided, only imports the specified exporter
- Optionalcategory: TelemetryExporterCategory
  optional exporter category; if provided, only imports exporters of the specified category
Returns Promise<LogExporterSkeleton[]>
the imported log exporters
- Defined in ops/cloud/TelemetryOps.ts:43

readTelemetry

readTelemetry(): Promise<TelemetryExporters>
Read all telemetry exporters

Returns Promise<TelemetryExporters>
a promise resolving to the telemetry exporters
- Defined in ops/cloud/TelemetryOps.ts:25

updateTelemetry

updateTelemetry(
    category: TelemetryExporterCategory,
    exporterId: string,
    exporterData: LogExporterSkeleton,
): Promise<LogExporterSkeleton>
Create or update a telemetry exporter
Parameters
- category: TelemetryExporterCategory
  exporter category
- exporterId: string
  exporter id
- exporterData: LogExporterSkeleton
  exporter configuration
Returns Promise<LogExporterSkeleton>
the updated exporter
- Defined in ops/cloud/TelemetryOps.ts:55