Skip to content

Commit

Permalink
Rename apm-generator to apm-synthtrace (#116075)
Browse files Browse the repository at this point in the history
  • Loading branch information
@sorenlouv
sorenlouv authored Oct 25, 2021
1 parent 0119bd8 commit 51f8fea
Show file tree
Hide file tree
Showing 66 changed files with 564 additions and 531 deletions.
36 changes: 18 additions & 18 deletions api_docs/deprecations_by_api.mdx
View file

Large diffs are not rendered by default.

101 changes: 49 additions & 52 deletions api_docs/deprecations_by_plugin.mdx
View file

Large diffs are not rendered by default.

288 changes: 0 additions & 288 deletions api_docs/elastic_apm_generator.json
View file

This file was deleted.

321 changes: 321 additions & 0 deletions api_docs/elastic_apm_synthtrace.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,321 @@
{
"id": "@elastic/apm-synthtrace",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [
{
"parentPluginId": "@elastic/apm-synthtrace",
"id": "def-server.getBreakdownMetrics",
"type": "Function",
"tags": [],
"label": "getBreakdownMetrics",
"description": [],
"signature": [
"(events: ",
"Fields",
"[]) => ",
"Fields",
"[]"
],
"path": "packages/elastic-apm-synthtrace/src/lib/utils/get_breakdown_metrics.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@elastic/apm-synthtrace",
"id": "def-server.getBreakdownMetrics.$1",
"type": "Array",
"tags": [],
"label": "events",
"description": [],
"signature": [
"Fields",
"[]"
],
"path": "packages/elastic-apm-synthtrace/src/lib/utils/get_breakdown_metrics.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@elastic/apm-synthtrace",
"id": "def-server.getObserverDefaults",
"type": "Function",
"tags": [],
"label": "getObserverDefaults",
"description": [],
"signature": [
"() => ",
"Fields"
],
"path": "packages/elastic-apm-synthtrace/src/lib/defaults/get_observer_defaults.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@elastic/apm-synthtrace",
"id": "def-server.getSpanDestinationMetrics",
"type": "Function",
"tags": [],
"label": "getSpanDestinationMetrics",
"description": [],
"signature": [
"(events: ",
"Fields",
"[]) => { \"metricset.name\": string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; '@timestamp'?: number | undefined; 'agent.name'?: string | undefined; 'agent.version'?: string | undefined; 'container.id'?: string | undefined; 'ecs.version'?: string | undefined; 'event.outcome'?: string | undefined; 'event.ingested'?: number | undefined; 'error.id'?: string | undefined; 'error.exception'?: ",
"Exception",
"[] | undefined; 'error.grouping_name'?: string | undefined; 'error.grouping_key'?: string | undefined; 'host.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.duration.histogram'?: { values: number[]; counts: 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.self_time.count'?: number | undefined; 'span.self_time.sum.us'?: number | undefined; 'system.process.memory.size'?: number | undefined; 'system.memory.actual.free'?: number | undefined; 'system.memory.total'?: number | undefined; 'system.cpu.total.norm.pct'?: number | undefined; 'system.process.memory.rss.bytes'?: number | undefined; 'system.process.cpu.total.norm.pct'?: number | undefined; }[]"
],
"path": "packages/elastic-apm-synthtrace/src/lib/utils/get_span_destination_metrics.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@elastic/apm-synthtrace",
"id": "def-server.getSpanDestinationMetrics.$1",
"type": "Array",
"tags": [],
"label": "events",
"description": [],
"signature": [
"Fields",
"[]"
],
"path": "packages/elastic-apm-synthtrace/src/lib/utils/get_span_destination_metrics.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@elastic/apm-synthtrace",
"id": "def-server.getTransactionMetrics",
"type": "Function",
"tags": [],
"label": "getTransactionMetrics",
"description": [],
"signature": [
"(events: ",
"Fields",
"[]) => { 'transaction.duration.histogram': { values: number[]; counts: number[]; }; _doc_count: number; '@timestamp'?: number | undefined; 'agent.name'?: string | undefined; 'agent.version'?: string | undefined; 'container.id'?: string | undefined; 'ecs.version'?: string | undefined; 'event.outcome'?: string | undefined; 'event.ingested'?: number | undefined; 'error.id'?: string | undefined; 'error.exception'?: ",
"Exception",
"[] | undefined; 'error.grouping_name'?: string | undefined; 'error.grouping_key'?: string | undefined; 'host.name'?: string | 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; 'span.self_time.count'?: number | undefined; 'span.self_time.sum.us'?: number | undefined; 'system.process.memory.size'?: number | undefined; 'system.memory.actual.free'?: number | undefined; 'system.memory.total'?: number | undefined; 'system.cpu.total.norm.pct'?: number | undefined; 'system.process.memory.rss.bytes'?: number | undefined; 'system.process.cpu.total.norm.pct'?: number | undefined; }[]"
],
"path": "packages/elastic-apm-synthtrace/src/lib/utils/get_transaction_metrics.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@elastic/apm-synthtrace",
"id": "def-server.getTransactionMetrics.$1",
"type": "Array",
"tags": [],
"label": "events",
"description": [],
"signature": [
"Fields",
"[]"
],
"path": "packages/elastic-apm-synthtrace/src/lib/utils/get_transaction_metrics.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@elastic/apm-synthtrace",
"id": "def-server.service",
"type": "Function",
"tags": [],
"label": "service",
"description": [],
"signature": [
"(name: string, environment: string, agentName: string) => ",
"Service"
],
"path": "packages/elastic-apm-synthtrace/src/lib/service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@elastic/apm-synthtrace",
"id": "def-server.service.$1",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string"
],
"path": "packages/elastic-apm-synthtrace/src/lib/service.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@elastic/apm-synthtrace",
"id": "def-server.service.$2",
"type": "string",
"tags": [],
"label": "environment",
"description": [],
"signature": [
"string"
],
"path": "packages/elastic-apm-synthtrace/src/lib/service.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@elastic/apm-synthtrace",
"id": "def-server.service.$3",
"type": "string",
"tags": [],
"label": "agentName",
"description": [],
"signature": [
"string"
],
"path": "packages/elastic-apm-synthtrace/src/lib/service.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@elastic/apm-synthtrace",
"id": "def-server.timerange",
"type": "Function",
"tags": [],
"label": "timerange",
"description": [],
"signature": [
"(from: number, to: number) => ",
"Timerange"
],
"path": "packages/elastic-apm-synthtrace/src/lib/timerange.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@elastic/apm-synthtrace",
"id": "def-server.timerange.$1",
"type": "number",
"tags": [],
"label": "from",
"description": [],
"signature": [
"number"
],
"path": "packages/elastic-apm-synthtrace/src/lib/timerange.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@elastic/apm-synthtrace",
"id": "def-server.timerange.$2",
"type": "number",
"tags": [],
"label": "to",
"description": [],
"signature": [
"number"
],
"path": "packages/elastic-apm-synthtrace/src/lib/timerange.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@elastic/apm-synthtrace",
"id": "def-server.toElasticsearchOutput",
"type": "Function",
"tags": [],
"label": "toElasticsearchOutput",
"description": [],
"signature": [
"({\n events,\n writeTargets,\n}: { events: ",
"Fields",
"[]; writeTargets: ",
"ElasticsearchOutputWriteTargets",
"; }) => ",
"ElasticsearchOutput",
"[]"
],
"path": "packages/elastic-apm-synthtrace/src/lib/output/to_elasticsearch_output.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@elastic/apm-synthtrace",
"id": "def-server.toElasticsearchOutput.$1",
"type": "Object",
"tags": [],
"label": "{\n events,\n writeTargets,\n}",
"description": [],
"path": "packages/elastic-apm-synthtrace/src/lib/output/to_elasticsearch_output.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@elastic/apm-synthtrace",
"id": "def-server.toElasticsearchOutput.$1.events",
"type": "Array",
"tags": [],
"label": "events",
"description": [],
"signature": [
"Fields",
"[]"
],
"path": "packages/elastic-apm-synthtrace/src/lib/output/to_elasticsearch_output.ts",
"deprecated": false
},
{
"parentPluginId": "@elastic/apm-synthtrace",
"id": "def-server.toElasticsearchOutput.$1.writeTargets",
"type": "Object",
"tags": [],
"label": "writeTargets",
"description": [],
"signature": [
"ElasticsearchOutputWriteTargets"
],
"path": "packages/elastic-apm-synthtrace/src/lib/output/to_elasticsearch_output.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
16 changes: 8 additions & 8 deletions api_docs/elastic_apm_generator.mdx → api_docs/elastic_apm_synthtrace.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
id: kibElasticApmGeneratorPluginApi
slug: /kibana-dev-docs/api/elastic-apm-generator
title: "@elastic/apm-generator"
id: kibElasticApmSynthtracePluginApi
slug: /kibana-dev-docs/api/elastic-apm-synthtrace
title: "@elastic/apm-synthtrace"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the @elastic/apm-generator plugin
summary: API docs for the @elastic/apm-synthtrace plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@elastic/apm-generator']
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@elastic/apm-synthtrace']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import elasticApmGeneratorObj from './elastic_apm_generator.json';
import elasticApmSynthtraceObj from './elastic_apm_synthtrace.json';

Elastic APM trace data generator

Expand All @@ -18,10 +18,10 @@ Contact [Owner missing] for questions regarding this plugin.

| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 17 | 0 | 17 | 2 |
| 18 | 0 | 18 | 6 |

## Server

### Functions
<DocDefinitionList data={elasticApmGeneratorObj.server.functions}/>
<DocDefinitionList data={elasticApmSynthtraceObj.server.functions}/>

Loading

0 comments on commit 51f8fea

Please sign in to comment.