kibana/api_docs/elastic_apm_generator.json

{
  "id": "@elastic/apm-generator",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@elastic/apm-generator",
        "id": "def-server.getObserverDefaults",
        "type": "Function",
        "tags": [],
        "label": "getObserverDefaults",
        "description": [],
        "signature": [
          "() => Partial<{ '@timestamp': number; 'agent.name': string; 'agent.version': string; 'ecs.version': string; 'event.outcome': string; 'event.ingested': number; 'metricset.name': string; 'observer.version': string; 'observer.version_major': number; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.environment': string; 'service.node.name': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; }>"
        ],
        "path": "packages/elastic-apm-generator/src/lib/defaults/get_observer_defaults.ts",
        "deprecated": false,
        "children": [],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@elastic/apm-generator",
        "id": "def-server.getSpanDestinationMetrics",
        "type": "Function",
        "tags": [],
        "label": "getSpanDestinationMetrics",
        "description": [],
        "signature": [
          "(events: Partial<{ '@timestamp': number; 'agent.name': string; 'agent.version': string; 'ecs.version': string; 'event.outcome': string; 'event.ingested': number; 'metricset.name': string; 'observer.version': string; 'observer.version_major': number; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.environment': string; 'service.node.name': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; }>[]) => Partial<{ '@timestamp': number; 'agent.name': string; 'agent.version': string; 'ecs.version': string; 'event.outcome': string; 'event.ingested': number; 'metricset.name': string; 'observer.version': string; 'observer.version_major': number; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.environment': string; 'service.node.name': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; }>[]"
        ],
        "path": "packages/elastic-apm-generator/src/lib/utils/get_span_destination_metrics.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "@elastic/apm-generator",
            "id": "def-server.getSpanDestinationMetrics.$1",
            "type": "Array",
            "tags": [],
            "label": "events",
            "description": [],
            "signature": [
              "Partial<{ '@timestamp': number; 'agent.name': string; 'agent.version': string; 'ecs.version': string; 'event.outcome': string; 'event.ingested': number; 'metricset.name': string; 'observer.version': string; 'observer.version_major': number; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.environment': string; 'service.node.name': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; }>[]"
            ],
            "path": "packages/elastic-apm-generator/src/lib/utils/get_span_destination_metrics.ts",
            "deprecated": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@elastic/apm-generator",
        "id": "def-server.getTransactionMetrics",
        "type": "Function",
        "tags": [],
        "label": "getTransactionMetrics",
        "description": [],
        "signature": [
          "(events: Partial<{ '@timestamp': number; 'agent.name': string; 'agent.version': string; 'ecs.version': string; 'event.outcome': string; 'event.ingested': number; 'metricset.name': string; 'observer.version': string; 'observer.version_major': number; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.environment': string; 'service.node.name': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; }>[]) => { \"transaction.duration.histogram\": { values: number[]; counts: number[]; }; _doc_count: number; '@timestamp'?: number | undefined; 'agent.name'?: string | undefined; 'agent.version'?: string | undefined; 'ecs.version'?: string | undefined; 'event.outcome'?: string | undefined; 'event.ingested'?: number | undefined; 'metricset.name'?: string | undefined; 'observer.version'?: string | undefined; 'observer.version_major'?: number | undefined; 'parent.id'?: string | undefined; 'processor.event'?: string | undefined; 'processor.name'?: string | undefined; 'trace.id'?: string | undefined; 'transaction.name'?: string | undefined; 'transaction.type'?: string | undefined; 'transaction.id'?: string | undefined; 'transaction.duration.us'?: number | undefined; 'transaction.sampled'?: true | undefined; 'service.name'?: string | undefined; 'service.environment'?: string | undefined; 'service.node.name'?: string | undefined; 'span.id'?: string | undefined; 'span.name'?: string | undefined; 'span.type'?: string | undefined; 'span.subtype'?: string | undefined; 'span.duration.us'?: number | undefined; 'span.destination.service.name'?: string | undefined; 'span.destination.service.resource'?: string | undefined; 'span.destination.service.type'?: string | undefined; 'span.destination.service.response_time.sum.us'?: number | undefined; 'span.destination.service.response_time.count'?: number | undefined; }[]"
        ],
        "path": "packages/elastic-apm-generator/src/lib/utils/get_transaction_metrics.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "@elastic/apm-generator",
            "id": "def-server.getTransactionMetrics.$1",
            "type": "Array",
            "tags": [],
            "label": "events",
            "description": [],
            "signature": [
              "Partial<{ '@timestamp': number; 'agent.name': string; 'agent.version': string; 'ecs.version': string; 'event.outcome': string; 'event.ingested': number; 'metricset.name': string; 'observer.version': string; 'observer.version_major': number; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.environment': string; 'service.node.name': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; }>[]"
            ],
            "path": "packages/elastic-apm-generator/src/lib/utils/get_transaction_metrics.ts",
            "deprecated": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@elastic/apm-generator",
        "id": "def-server.service",
        "type": "Function",
        "tags": [],
        "label": "service",
        "description": [],
        "signature": [
          "(name: string, environment: string, agentName: string) => ",
          "Service"
        ],
        "path": "packages/elastic-apm-generator/src/lib/service.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "@elastic/apm-generator",
            "id": "def-server.service.$1",
            "type": "string",
            "tags": [],
            "label": "name",
            "description": [],
            "signature": [
              "string"
            ],
            "path": "packages/elastic-apm-generator/src/lib/service.ts",
            "deprecated": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@elastic/apm-generator",
            "id": "def-server.service.$2",
            "type": "string",
            "tags": [],
            "label": "environment",
            "description": [],
            "signature": [
              "string"
            ],
            "path": "packages/elastic-apm-generator/src/lib/service.ts",
            "deprecated": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@elastic/apm-generator",
            "id": "def-server.service.$3",
            "type": "string",
            "tags": [],
            "label": "agentName",
            "description": [],
            "signature": [
              "string"
            ],
            "path": "packages/elastic-apm-generator/src/lib/service.ts",
            "deprecated": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@elastic/apm-generator",
        "id": "def-server.timerange",
        "type": "Function",
        "tags": [],
        "label": "timerange",
        "description": [],
        "signature": [
          "(from: number, to: number) => ",
          "Timerange"
        ],
        "path": "packages/elastic-apm-generator/src/lib/timerange.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "@elastic/apm-generator",
            "id": "def-server.timerange.$1",
            "type": "number",
            "tags": [],
            "label": "from",
            "description": [],
            "signature": [
              "number"
            ],
            "path": "packages/elastic-apm-generator/src/lib/timerange.ts",
            "deprecated": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@elastic/apm-generator",
            "id": "def-server.timerange.$2",
            "type": "number",
            "tags": [],
            "label": "to",
            "description": [],
            "signature": [
              "number"
            ],
            "path": "packages/elastic-apm-generator/src/lib/timerange.ts",
            "deprecated": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@elastic/apm-generator",
        "id": "def-server.toElasticsearchOutput",
        "type": "Function",
        "tags": [],
        "label": "toElasticsearchOutput",
        "description": [],
        "signature": [
          "(events: Partial<{ '@timestamp': number; 'agent.name': string; 'agent.version': string; 'ecs.version': string; 'event.outcome': string; 'event.ingested': number; 'metricset.name': string; 'observer.version': string; 'observer.version_major': number; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.environment': string; 'service.node.name': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; }>[], versionOverride: string | undefined) => { _index: string; _source: {}; }[]"
        ],
        "path": "packages/elastic-apm-generator/src/lib/output/to_elasticsearch_output.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "@elastic/apm-generator",
            "id": "def-server.toElasticsearchOutput.$1",
            "type": "Array",
            "tags": [],
            "label": "events",
            "description": [],
            "signature": [
              "Partial<{ '@timestamp': number; 'agent.name': string; 'agent.version': string; 'ecs.version': string; 'event.outcome': string; 'event.ingested': number; 'metricset.name': string; 'observer.version': string; 'observer.version_major': number; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.environment': string; 'service.node.name': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; }>[]"
            ],
            "path": "packages/elastic-apm-generator/src/lib/output/to_elasticsearch_output.ts",
            "deprecated": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@elastic/apm-generator",
            "id": "def-server.toElasticsearchOutput.$2",
            "type": "string",
            "tags": [],
            "label": "versionOverride",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "packages/elastic-apm-generator/src/lib/output/to_elasticsearch_output.ts",
            "deprecated": false,
            "isRequired": false
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}