@twin.org/node-core 0.9.5-next.1 → 0.9.5-next.2

package/docs/reference/index.md

@@ -37,6 +37,10 @@
 - [CONTEXT\_ID\_HANDLER\_FEATURE\_DID](variables/CONTEXT_ID_HANDLER_FEATURE_DID.md)
 - [CONTEXT\_ID\_HANDLER\_FEATURE\_TENANT](variables/CONTEXT_ID_HANDLER_FEATURE_TENANT.md)
 - [DEFAULT\_HEALTH\_EXCLUDE\_CLONE\_COMPONENTS](variables/DEFAULT_HEALTH_EXCLUDE_CLONE_COMPONENTS.md)
+- [TRACING\_FACADE\_NAME](variables/TRACING_FACADE_NAME.md)
+- [COMPONENT\_FACTORY\_TYPE\_NAME](variables/COMPONENT_FACTORY_TYPE_NAME.md)
+- [DEFAULT\_TRACING\_FACADE\_FACTORIES](variables/DEFAULT_TRACING_FACADE_FACTORIES.md)
+- [DEFAULT\_TRACING\_FACADE\_COMPONENT\_EXCLUDE\_TYPES](variables/DEFAULT_TRACING_FACADE_COMPONENT_EXCLUDE_TYPES.md)
 - [ModuleProtocol](variables/ModuleProtocol.md)
 
 ## Functions

package/docs/reference/interfaces/IEngineEnvironmentVariables.md

@@ -1191,6 +1191,68 @@ The type of tracing connector, comma-separated for multiple: entity-storage, ope
 
 ***
 
+### facade? {#facade}
+
+> `optional` **facade?**: `string`
+
+The type of facade to activate, comma-separated for multiple: tracing. When this is not set no
+facades are activated.
+
+***
+
+### tracingFacadeFactories? {#tracingfacadefactories}
+
+> `optional` **tracingFacadeFactories?**: `string`
+
+The factories the tracing facade is activated on, as a comma separated list of factory type names
+e.g. "component,vault", replacing the default set rather than adding to it. Only applies when the
+tracing facade is activated.
+
+***
+
+### tracingFacadeComponentExcludeTypes? {#tracingfacadecomponentexcludetypes}
+
+> `optional` **tracingFacadeComponentExcludeTypes?**: `string`
+
+Additional instance types the tracing facade is not applied to in the component factory, as a comma
+separated list of regular expressions matched anywhere in the type name e.g. "^my-tracing-service$".
+These extend the types which are always excluded, "tracing", "telemetry", "metrics", "logging" and
+"platform", they do not replace them.
+
+***
+
+### tracingFacadeExcludeParams? {#tracingfacadeexcludeparams}
+
+> `optional` **tracingFacadeExcludeParams?**: `string`
+
+Additional parameter names the tracing facade does not record, as a comma separated list
+e.g. "ssn,accountNumber". These extend the names which are always excluded, they do not
+replace them.
+
+***
+
+### tracingFacadeExcludeMethods? {#tracingfacadeexcludemethods}
+
+> `optional` **tracingFacadeExcludeMethods?**: `string`
+
+Additional method names the tracing facade does not record a span for, as a comma separated
+list e.g. "health,ping". These extend the names which are always excluded, they do not
+replace them.
+
+***
+
+### tracingFacadeIncludeObjects? {#tracingfacadeincludeobjects}
+
+> `optional` **tracingFacadeIncludeObjects?**: `string`
+
+The object values the tracing facade records, as a comma separated list of patterns matched
+against the end of "parameter" or "parameter.property", where the returned value is named
+"resolved" e.g. "filter.id,resolved.id". Naming the parameter records the whole object
+including any secrets it holds, naming a property records only that property. Object
+parameters and returned objects are omitted unless matched here.
+
+***
+
 ### openTelemetryTracingTracerName? {#opentelemetrytracingtracername}
 
 > `optional` **openTelemetryTracingTracerName?**: `string`

package/docs/reference/variables/COMPONENT_FACTORY_TYPE_NAME.md

@@ -0,0 +1,5 @@
+# Variable: COMPONENT\_FACTORY\_TYPE\_NAME
+
+> `const` **COMPONENT\_FACTORY\_TYPE\_NAME**: `"component"` = `"component"`
+
+The type name of the component factory.

package/docs/reference/variables/DEFAULT_TRACING_FACADE_COMPONENT_EXCLUDE_TYPES.md

@@ -0,0 +1,8 @@
+# Variable: DEFAULT\_TRACING\_FACADE\_COMPONENT\_EXCLUDE\_TYPES
+
+> `const` **DEFAULT\_TRACING\_FACADE\_COMPONENT\_EXCLUDE\_TYPES**: `string`[]
+
+The instance types the tracing facade is never applied to in the component factory, matched as
+regular expressions anywhere in the type name. The facade resolves the tracing and logging
+components while recording a span, so wrapping those results in an endless call chain. The
+remaining patterns cover the high volume infrastructure services whose spans carry little value.

package/docs/reference/variables/DEFAULT_TRACING_FACADE_FACTORIES.md

@@ -0,0 +1,5 @@
+# Variable: DEFAULT\_TRACING\_FACADE\_FACTORIES
+
+> `const` **DEFAULT\_TRACING\_FACADE\_FACTORIES**: `string`[]
+
+The default factories the tracing facade is activated on.

package/docs/reference/variables/TRACING_FACADE_NAME.md

@@ -0,0 +1,5 @@
+# Variable: TRACING\_FACADE\_NAME
+
+> `const` **TRACING\_FACADE\_NAME**: `"tracing-facade"` = `"tracing-facade"`
+
+The name the tracing facade is registered with in the facade factory

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/node-core",
-	"version": "0.9.5-next.1",
+	"version": "0.9.5-next.2",
 	"description": "TWIN Node Core for serving APIs using the specified configuration",
 	"repository": {
 		"type": "git",
@@ -42,6 +42,7 @@
 		"@twin.org/standards-w3c-odrl": "next",
 		"@twin.org/telemetry-connector-opentelemetry": "next",
 		"@twin.org/tracing-connector-opentelemetry": "next",
+		"@twin.org/tracing-facades": "next",
 		"@twin.org/tracing-models": "next",
 		"@twin.org/vault-models": "next",
 		"@twin.org/wallet-connector-entity-storage": "next",