@process-engine/logging_api_contracts
Advanced tools
Comparing version 2.0.0-feature-d6425d-k1uhkkfx to 2.0.0-feature-eee0ac-k1urzkzx
@@ -1,2 +0,2 @@ | ||
define(["require", "exports", "./log_entry", "./log_level", "./rest_settings"], function (require, exports, log_entry_1, log_level_1, rest_settings_1) { | ||
define(["require", "exports", "./log_entry", "./log_level", "./metric_measurement_point"], function (require, exports, log_entry_1, log_level_1, metric_measurement_point_1) { | ||
"use strict"; | ||
@@ -9,4 +9,4 @@ function __export(m) { | ||
__export(log_level_1); | ||
__export(rest_settings_1); | ||
__export(metric_measurement_point_1); | ||
}); | ||
//# sourceMappingURL=index.js.map |
@@ -8,4 +8,6 @@ define(["require", "exports"], function (require, exports) { | ||
* FlowNodeInstance to which the entry belongs, | ||
* aswell as a timestamp, LogLvel and the concrete message that was logged. | ||
* aswell as a timestamp, LogLevel and the concrete message that was logged. | ||
* | ||
* When logging a metric, the message will be something like "onEnter", "onExit", etc. | ||
* | ||
* The properties here are ordered in the same manner as they are in the | ||
@@ -12,0 +14,0 @@ * actual log file. |
@@ -8,3 +8,3 @@ "use strict"; | ||
__export(require("./log_level")); | ||
__export(require("./rest_settings")); | ||
__export(require("./metric_measurement_point")); | ||
//# sourceMappingURL=index.js.map |
@@ -7,4 +7,6 @@ "use strict"; | ||
* FlowNodeInstance to which the entry belongs, | ||
* aswell as a timestamp, LogLvel and the concrete message that was logged. | ||
* aswell as a timestamp, LogLevel and the concrete message that was logged. | ||
* | ||
* When logging a metric, the message will be something like "onEnter", "onExit", etc. | ||
* | ||
* The properties here are ordered in the same manner as they are in the | ||
@@ -11,0 +13,0 @@ * actual log file. |
import { IIdentity } from '@essential-projects/iam_contracts'; | ||
import { LogEntry } from './log_entry'; | ||
import { LogLevel } from './log_level'; | ||
import { MetricMeasurementPoint } from './metric_measurement_point'; | ||
/** | ||
@@ -28,7 +29,9 @@ * Contains functions for writing and retrieving content from logfiles. | ||
* @param logLevel The loglevel to use. | ||
* @param message The message to write into the log entry. | ||
* @param measuredAt The type of log (OnEnter, OnExit, etc). | ||
* @param message Optional: A message for the LogEntry. | ||
* @param timestamp Optional: The timestamp to use for the log entry. | ||
* Defaults to "now". | ||
* @param error Optional: An error to attach to the log. | ||
*/ | ||
writeLogForProcessModel(correlationId: string, processModelId: string, processInstanceId: string, logLevel: LogLevel, message: string, timestamp?: Date): Promise<void>; | ||
writeLogForProcessModel(correlationId: string, processModelId: string, processInstanceId: string, logLevel: LogLevel, measuredAt: MetricMeasurementPoint, message?: string, timestamp?: Date, error?: Error): Promise<void>; | ||
/** | ||
@@ -48,7 +51,10 @@ * Writes a log entry for a specific FlowNode of a ProcessModel within a | ||
* @param logLevel The loglevel to use. | ||
* @param message The message to write into the log entry. | ||
* @param measuredAt The type of log (OnEnter, OnExit, etc). | ||
* @param message Optional: The message to write into the log entry. | ||
* @param tokenPayload The payload of the FlowNodeInstance's current token. | ||
* @param timestamp Optional: The timestamp to use for the log entry. | ||
* Defaults to "now". | ||
* @param error Optional: An error to attach to the log. | ||
*/ | ||
writeLogForFlowNode(correlationId: string, processModelId: string, processInstanceId: string, flowNodeInstanceId: string, flowNodeId: string, logLevel: LogLevel, message: string, timestamp?: Date): Promise<void>; | ||
writeLogForFlowNode(correlationId: string, processModelId: string, processInstanceId: string, flowNodeInstanceId: string, flowNodeId: string, logLevel: LogLevel, measuredAt: MetricMeasurementPoint, tokenPayload: any, message?: string, timestamp?: Date, error?: Error): Promise<void>; | ||
/** | ||
@@ -55,0 +61,0 @@ * Places all logs for the given ProcessModel into the "archive" folder. |
import { LogEntry } from './log_entry'; | ||
import { LogLevel } from './log_level'; | ||
import { MetricMeasurementPoint } from './metric_measurement_point'; | ||
/** | ||
@@ -27,6 +28,8 @@ * Contains functions for writing and retrieving content from logfiles. | ||
* @param message The message to write into the log entry. | ||
* @param measuredAt The type of log (OnEnter, OnExit, etc). | ||
* @param timestamp Optional: The timestamp to use for the log entry. | ||
* Defaults to "now". | ||
* @param error Optional: An error to attach to the log. | ||
*/ | ||
writeLogForProcessModel(correlationId: string, processModelId: string, processInstanceId: string, logLevel: LogLevel, message: string, timestamp?: Date): Promise<void>; | ||
writeLogForProcessModel(correlationId: string, processModelId: string, processInstanceId: string, logLevel: LogLevel, measuredAt: MetricMeasurementPoint, message?: string, timestamp?: Date, error?: Error): Promise<void>; | ||
/** | ||
@@ -47,6 +50,9 @@ * Writes a log entry for a specific FlowNode of a ProcessModel within a | ||
* @param message The message to write into the log entry. | ||
* @param measuredAt The type of log (OnEnter, OnExit, etc). | ||
* @param tokenPayload The payload of the FlowNodeInstance's current token. | ||
* @param timestamp Optional: The timestamp to use for the log entry. | ||
* Defaults to "now". | ||
* @param error Optional: An error to attach to the log. | ||
*/ | ||
writeLogForFlowNode(correlationId: string, processModelId: string, processInstanceId: string, flowNodeInstanceId: string, flowNodeId: string, logLevel: LogLevel, message: string, timestamp?: Date): Promise<void>; | ||
writeLogForFlowNode(correlationId: string, processModelId: string, processInstanceId: string, flowNodeInstanceId: string, flowNodeId: string, logLevel: LogLevel, measuredAt: MetricMeasurementPoint, tokenPayload: any, message?: string, timestamp?: Date, error?: Error): Promise<void>; | ||
/** | ||
@@ -53,0 +59,0 @@ * Places all logs for the given ProcessModel into the "archive" folder. |
export * from './ilogging_api'; | ||
export * from './ilogging_repository_config'; | ||
export * from './ilogging_repository'; | ||
export * from './log_entry'; | ||
export * from './log_level'; | ||
export * from './rest_settings'; | ||
export * from './metric_measurement_point'; |
import { LogLevel } from './log_level'; | ||
import { MetricMeasurementPoint } from './metric_measurement_point'; | ||
/** | ||
@@ -6,4 +7,6 @@ * Describes a single log entry. | ||
* FlowNodeInstance to which the entry belongs, | ||
* aswell as a timestamp, LogLvel and the concrete message that was logged. | ||
* aswell as a timestamp, LogLevel and the concrete message that was logged. | ||
* | ||
* When logging a metric, the message will be something like "onEnter", "onExit", etc. | ||
* | ||
* The properties here are ordered in the same manner as they are in the | ||
@@ -21,2 +24,5 @@ * actual log file. | ||
message: string; | ||
measuredAt: MetricMeasurementPoint; | ||
tokenPayload: any; | ||
error?: Error; | ||
} |
{ | ||
"name": "@process-engine/logging_api_contracts", | ||
"version": "2.0.0-feature-d6425d-k1uhkkfx", | ||
"version": "2.0.0-feature-eee0ac-k1urzkzx", | ||
"description": "the api-package for process-engine logging", | ||
@@ -29,3 +29,3 @@ "main": "dist/commonjs/index.js", | ||
"@essential-projects/eslint-config": "^1.0.0", | ||
"@process-engine/ci_tools": "2.2.0-beta.4", | ||
"@process-engine/ci_tools": "^2.2.0", | ||
"eslint": "^5.16.0", | ||
@@ -32,0 +32,0 @@ "typescript": "^3.4.5" |
@@ -5,2 +5,3 @@ import {IIdentity} from '@essential-projects/iam_contracts'; | ||
import {LogLevel} from './log_level'; | ||
import {MetricMeasurementPoint} from './metric_measurement_point'; | ||
@@ -33,5 +34,7 @@ /** | ||
* @param logLevel The loglevel to use. | ||
* @param message The message to write into the log entry. | ||
* @param measuredAt The type of log (OnEnter, OnExit, etc). | ||
* @param message Optional: A message for the LogEntry. | ||
* @param timestamp Optional: The timestamp to use for the log entry. | ||
* Defaults to "now". | ||
* @param error Optional: An error to attach to the log. | ||
*/ | ||
@@ -43,4 +46,6 @@ writeLogForProcessModel( | ||
logLevel: LogLevel, | ||
message: string, | ||
measuredAt: MetricMeasurementPoint, | ||
message?: string, | ||
timestamp?: Date, | ||
error?: Error, | ||
): Promise<void>; | ||
@@ -62,5 +67,8 @@ | ||
* @param logLevel The loglevel to use. | ||
* @param message The message to write into the log entry. | ||
* @param measuredAt The type of log (OnEnter, OnExit, etc). | ||
* @param message Optional: The message to write into the log entry. | ||
* @param tokenPayload The payload of the FlowNodeInstance's current token. | ||
* @param timestamp Optional: The timestamp to use for the log entry. | ||
* Defaults to "now". | ||
* @param error Optional: An error to attach to the log. | ||
*/ | ||
@@ -74,4 +82,7 @@ writeLogForFlowNode( | ||
logLevel: LogLevel, | ||
message: string, | ||
measuredAt: MetricMeasurementPoint, | ||
tokenPayload: any, | ||
message?: string, | ||
timestamp?: Date, | ||
error?: Error, | ||
): Promise<void>; | ||
@@ -78,0 +89,0 @@ |
import {LogEntry} from './log_entry'; | ||
import {LogLevel} from './log_level'; | ||
import {MetricMeasurementPoint} from './metric_measurement_point'; | ||
@@ -30,4 +31,6 @@ /** | ||
* @param message The message to write into the log entry. | ||
* @param measuredAt The type of log (OnEnter, OnExit, etc). | ||
* @param timestamp Optional: The timestamp to use for the log entry. | ||
* Defaults to "now". | ||
* @param error Optional: An error to attach to the log. | ||
*/ | ||
@@ -39,4 +42,6 @@ writeLogForProcessModel( | ||
logLevel: LogLevel, | ||
message: string, | ||
measuredAt: MetricMeasurementPoint, | ||
message?: string, | ||
timestamp?: Date, | ||
error?: Error, | ||
): Promise<void>; | ||
@@ -59,4 +64,7 @@ | ||
* @param message The message to write into the log entry. | ||
* @param measuredAt The type of log (OnEnter, OnExit, etc). | ||
* @param tokenPayload The payload of the FlowNodeInstance's current token. | ||
* @param timestamp Optional: The timestamp to use for the log entry. | ||
* Defaults to "now". | ||
* @param error Optional: An error to attach to the log. | ||
*/ | ||
@@ -70,4 +78,7 @@ writeLogForFlowNode( | ||
logLevel: LogLevel, | ||
message: string, | ||
measuredAt: MetricMeasurementPoint, | ||
tokenPayload: any, | ||
message?: string, | ||
timestamp?: Date, | ||
error?: Error, | ||
): Promise<void>; | ||
@@ -74,0 +85,0 @@ |
export * from './ilogging_api'; | ||
export * from './ilogging_repository_config'; | ||
export * from './ilogging_repository'; | ||
export * from './log_entry'; | ||
export * from './log_level'; | ||
export * from './rest_settings'; | ||
export * from './metric_measurement_point'; |
import {LogLevel} from './log_level'; | ||
import {MetricMeasurementPoint} from './metric_measurement_point'; | ||
@@ -7,4 +8,6 @@ /** | ||
* FlowNodeInstance to which the entry belongs, | ||
* aswell as a timestamp, LogLvel and the concrete message that was logged. | ||
* aswell as a timestamp, LogLevel and the concrete message that was logged. | ||
* | ||
* When logging a metric, the message will be something like "onEnter", "onExit", etc. | ||
* | ||
* The properties here are ordered in the same manner as they are in the | ||
@@ -23,3 +26,7 @@ * actual log file. | ||
public message: string; | ||
public measuredAt: MetricMeasurementPoint; | ||
// eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
public tokenPayload: any; | ||
public error?: Error; | ||
} |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
31008
48
592