Tracing API documentation version v3

http://server:port/activeviam/tracing/rest/v3

Home

This document describes the REST API of Tracing.

Note: the root URL provided here will depend of the deployment of your application.

/publish

API to post a client trace to Activepivot server. Currently, ActivePivot server does not provide a default implementation for the tracing rest service. It is up to the user to implement such endpoint.

post

post

Post a client trace to Activepivot server.

Post a client trace to Activepivot server.

Body

Type: application/json

Schema:

{
	"$schema": "http://json-schema.org/draft-07/schema",
	"$id": "http://example.com/example.json",
	"type": "array",
	"title": "The Root Schema",
	"description": "The root schema comprises the entire JSON document.",
	"items": {
		"$id": "#/items",
		"type": "object",
		"title": "The Items Schema",
		"description": "An explanation about the purpose of this instance.",
		"examples": [
			{
				"traceId": "81cd8bade5974f0f8c9776558c842e1e",
				"spanId": "291d9d5937274670",
				"parentSpanId": "1a1d9d2933254679",
				"startTimestamp": 1584376809592.0,
				"finishTimestamp": 1584376809601.0,
				"tags": {
					"username": "admin",
					"name": "",
					"containerKey": "content-editor"
				},
				"logs": [
					{
						"key": "ownLoadingFinished",
						"value": "Container of type content-editor finished loading.",
						"timestamp": 1584376809601.0
					}
				]
			}
		],
		"required": [
			"traceId",
			"spanId",
			"name",
			"startTimestamp",
			"finishTimestamp"
		],
		"properties": {
			"traceId": {
				"$id": "#/items/properties/traceId",
				"type": "string",
				"title": "The Traceid Schema",
				"description": "String representation of the 128-bits trace id hexadecimal value",
				"pattern": "[0-9a-fA-F]{32}",
				"minLength": 32,
				"maxLength": 32,
				"examples": [
					"81cd8bade5974f0f8c9776558c842e1e"
				]
			},
			"spanId": {
				"$id": "#/items/properties/spanId",
				"type": "string",
				"title": "The Spanid Schema",
				"description": "String representation of the 64-bits span id hexadecimal value",
				"pattern": "[0-9a-fA-F]{16}",
				"minLength": 16,
				"maxLength": 16,
				"examples": [
					"291d9d5937274670"
				]
			},
			"parentSpanId": {
				"$id": "#/items/properties/parentSpanId",
				"type": "string",
				"title": "The Parentspanid Schema",
				"description": "String representation of the 64-bits parent span id hexadecimal value",
				"pattern": "[0-9a-fA-F]{16}",
				"minLength": 16,
				"maxLength": 16,
				"examples": [
					"1a1d9d2933254679"
				]
			},
			"name": {
				"$id": "#/items/properties/name",
				"type": "string",
				"title": "The name Schema",
				"description": "The name of the span"
			},
			"startTimestamp": {
				"$id": "#/items/properties/startTimestamp",
				"type": "integer",
				"title": "The Starttimestamp Schema",
				"description": "The trace starting time.",
				"default": 0,
				"examples": [
					1584376809592
				]
			},
			"finishTimestamp": {
				"$id": "#/items/properties/finishTimestamp",
				"type": "integer",
				"title": "The Finishtimestamp Schema",
				"description": "The trace ending time.",
				"default": 0,
				"examples": [
					1584376809601
				]
			},
			"tags": {
				"$id": "#/items/properties/tags",
				"type": "object",
				"title": "The Tags Schema",
				"description": "Tags including additional trace information.",
				"default": {},
				"examples": [
					{
						"containerKey": "content-editor",
						"username": "admin",
						"name": ""
					}
				]
			},
			"logs": {
				"$id": "#/items/properties/logs",
				"type": "array",
				"title": "The Logs Schema",
				"description": "Trace information to include in JSON logs shipped to a search engine (ElasticSearch for example).",
				"default": [],
				"items": {
					"$id": "#/items/properties/logs/items",
					"type": "object",
					"title": "The Items Schema",
					"description": "An explanation about the purpose of this instance.",
					"default": {},
					"examples": [
						{
							"timestamp": 1584376809601.0,
							"key": "ownLoadingFinished",
							"value": "Container of type content-editor finished loading."
						}
					],
					"properties": {
						"key": {
							"$id": "#/items/properties/logs/items/properties/key",
							"type": "string",
							"title": "The Key Schema",
							"description": "The key.",
							"examples": [
								"ownLoadingFinished"
							]
						},
						"value": {
							"$id": "#/items/properties/logs/items/properties/value",
							"type": "string",
							"title": "The Value Schema",
							"description": "The value.",
							"examples": [
								"Container of type content-editor finished loading."
							]
						},
						"timestamp": {
							"$id": "#/items/properties/logs/items/properties/timestamp",
							"type": "integer",
							"title": "The Timestamp Schema",
							"description": "The timestamp.",
							"default": 0,
							"examples": [
								1584376809601
							]
						},
						"required": [
							"key",
							"value",
							"timestamp"
						]
					}
				}
			}
		}
	}
}

Example:

[
	{
		"traceId": "81cd8bade5974f0f8c9776558c842e1e",
		"spanId": "291d9d5937274670",
		"parentSpanId": "1a1d9d2933254679",
		"name": "activeui-101",
		"startTimestamp": 1584376809592,
		"finishTimestamp": 1584376809601,
		"tags": {
			"containerKey": "content-editor",
			"username": "admin"
		},
		"logs": [
			{
				"key": "ownLoadingFinished",
				"value": "Container of type content-editor finished loading.",
				"timestamp": 1584376809601
			}
		]
	}
]

HTTP status code 200

Body

Type: application/json

Example:

{
}