v5.1.5

Release v5.1.5

Bugfixes

Fix hanging shutdown if server is down in ElasticsearchPipelineStage

The Elasticsearch Pipeline Stage caused a delay of 30 seconds when shutting down, if messages were buffered, but could not be sent to the configured elasticsearch endpoint.

v5.1.4

Release v5.1.4

Bugfixes

Fix infinite loop in connectivity monitoring task in LocalLogServicePipelineConnection

v5.1.3

Release v5.1.3

Bugfixes

Fix periodic delay when processing messages in LocalLogServicePipelineStage

The delay could occur if the local log service is not running and auto-reconnecting is enabled. As long as the stage tries to establish a connection to the service the stage lock was kept locked blocking a thread trying to write a log message.

v5.1.2

Release v5.1.2

Bugfixes

Elasticsearch Pipeline Stage: Fix response handling

As the pipeline stage was adjusted to work with data streams the index action was replaced with the create action. The changed action was not properly considered when processing the response. This could lead to sending messages multiple times if at least one operation in a bulk request has failed.

v5.1.1

Release v5.1.1

Bugfixes

Change op_action from 'index' to 'create' when sending messages to elasticsearch

Formerly action index was used to index messages. This action can overwrite an existing document, while create can not. Action create is required to properly work with data streams.

v5.1.0

Release v5.1.0

New Features

Logging Interface

The logging interface (mainly the LogWriter class and LogLevel class) have been pulled out into a separate project available via NuGet package GriffinPlus.Lib.Logging.Interface. The interface is very stable. This allows libraries to use the interface package instead of the full-featured GriffinPlus.Lib.Logging package to write to the log without the need to update library packages with every release of the full-featured GriffinPlus.Lib.Logging package. The interface should stay stable even in case of major version releases of the logging package. Some functionality has moved, but for compatibility reasons forwards have been established. These forwards are marked as obsolete, so users can easily migrate their code to the new version without breaking anything. These forwards will be removed with the next major release.

v5.0.1

Release v5.0.1

Bugfixes

Fix determining the application name

The application name was set to the name of the current application domain. It should be the name of the process by default.

v5.0.0

Release v5.0.0

This release contains breaking changes!

New Features

Bugfixes

Fix broken link between log configurations and log writers and pipeline stages

All configurations now provide a Changed event that is raised when something in the configuration changes. Event handlers are fired using the synchronization context of the thread registering the event, so it is suitable for use in conjunction with GUIs. Raising the Changed event can be suspended temporarily.

The FileBackedLogConfiguration effectively supports reloading its *.gplogconf file on changes now.

Fix synchronization issue when shutting down pipeline stages deriving from the AsyncProcessingPipelineStage class

The boolean member variable indicating that the stage is shutting down was not volatile, so it was not evaluated properly in the processing loop of the stage. This behavior deferred the shutdown of the stage.

Fix generating log writer name from type

The name generation now supports generic types and generic type definitions. Information about the assembly (name, version, hash) containing the type is properly pruned to create a clean name.

Fix ProcessIntegration creating zombie processes

The ProcessIntegration class implements IDisposable now. Disposing a ProcessIntegration object waits for the process to exit and cleans up the associated Process object. This should avoid generating zombie processes on Linux.

Fix retrying to send messages via the ElasticsearchPipelineStage after connection issues

Fix consolidating cache after pruning a FileBackedLogMessageCollection

Fix cache alignment issue after pruning in FileBackedLogMessageCollection

Fix raising overview collection changed events in FileBackedLogMessageCollection

Fix search text handling in SelectableFileBackedLogMessageFilter (SQL injection issue)

Fix 'append' mode in FileWriterPipelineStage

The file position was not moved to end of the file when opening in 'append' mode, so new messages have overwritten messages in an existing file.

Fix loosing messages in FileWriterPipelineStage

The stage re-opened the log file when a setting has changed. Re-opening truncated the log file, so messages were lost.

Fix patching assembly info

Azure pipelines did not patch the correct assembly information files, so all assemblies had version 0.0.0.0.

Other Changes

Remove support for .NET Core 2.1

Although direct support for .NET Core 2.1 has been removed, the .NET Standard 2.0 Version is still usable on .NET Core 2.1.

Revise base classes for pipeline stages

The IProcessingPipelineStage interface has been removed in favor of a common base class (ProcessingPipelineStage). This was necessary to better integrate pipeline stages into the logging subsystem. There is a derivation for synchronous pipeline stages (SyncProcessingPipelineStage) and asynchronous pipeline stages (AsyncProcessingPipelineStage) now.

Redesign initialization of logging subsystem due to configuration issues

The configuration and the processing pipeline was set up independently from each other, so pipeline stages created a temporary set of default settings to get into an operable state. As soon as pipeline stages were dropped into the logging subsystem, the configuration of the logging subsystem became active replacing the temporary stage settings. This lead to discarding settings that were changed by a stage's property.

The Log class now provides an Initialize<TConfiguration>(...) method that creates a configuration and the pipeline stages in a single step. Stages are directly bound to this configuration. Furthermore stages now need to provide a parameterless constructor to work with the logging subsystem. The name of a pipeline stage and its settings are passed to the parameterless constructor on a side channel using the ProcessingPipelineStage.Create<TStage>() method. A pipeline builder mechanism assists with setting up pipeline stages during initialization and hides this magic from the user.

Revise pruning messages in LogFile / FileBackedLogMessageCollection

When pruning old log messages the FileBackedLogMessageCollection class raised the CollectionChanged event, but notified about a collection reset instead of a limited number of items being removed from the collection. This behavior was rather unexpected and different from the behavior of the LogMessageCollection class working purely in memory. The FileBackedLogMessageCollection behaves as the LogMessageCollection now, but the change induced reading log messages from the log file before actually removing the messages. If the user of the FileBackedLogMessageCollection class knows that event recipients do not need the removed messages, he can set the ReturnDummyMessagesWhenPruning property to true to pass a special collection with dummy messages to event recipients. The number of dummy messages is the same as the number of messages that has actually been removed. This way reading unneeded log messages can be avoided to improve performance.

Make predefined log levels customizable when deriving from the SelectableLogMessageFilter class

Derived filter classes can now influence which log levels are considered predefined log levels. This is especially important when interoperating with logging systems that use other predefined log levels than Griffin+ Logging.

Add option to customize resetting SelectableLogMessageFilter class

The DisableFilterOnReset property determines whether the filter is disabled when it is reset (default is false). The UnselectItemsOnReset property determines whether filter items are unselected when the filter is reset (default is false).

Let ElasticsearchPipelineStage add field 'ecs.version' to written events

The ECS requires writing the version field to determine the ECS version the writer complies to.

Add overrides for handling stage setting changes collectively

The base classes for processing pipeline stages now provide the following overridable methods that are invoked when a registered pipeline stage setting changes:

• AsyncProcessingPipelineStage.OnSettingsChangedAsync()
• SyncProcessingPipelineStage.OnSettingsChanged()

v4.0.5

Release v4.0.5

Bugfixes

Fix shutting down elasticsearch pipeline stage when endpoint is not available

If no elasticsearch endpoint was available the processing thread went to sleep before trying again. In this case the pipeline stage did not shut down until the shutdown timeout elapsed causing an unnecessary delay of 30 seconds.

v4.0.4

Release v4.0.4

Other Changes

Logging unhandled exceptions using the system logger

An application usually terminates when unhandled exceptions occur. Log messages buffered in stages might get lost in this case. These exceptions are now logged using the system logger and the configured pipeline stages to allow further investigation. After logging the incident the logging subsystem is shut down gracefully and the process is terminated. Terminating the process can be disabled by setting the TerminateProcessOnUnhandledException property of the Log class to false.

Report not shutting down gracefully to system log

Some pipeline stages need some time to process buffered messages, so exiting the process without shutting down gracefully can result in message loss.

ElasticsearchPipelineStage does not block process exit, if not shut down gracefully

Formerly a foreground thread was used for processing. The foreground thread could keep the process from exiting, if the pipeline stage was not shut down gracefully at the end.