@cs/event-logger

README

Composed Event Logger is an extendable, ready to use LabVIEW event logger. Injectable event destinations, referred to as 'sinks', log entry formats, and application wide error processing allow extension and customization.

Getting Started

  • Install this package through GPM

  • All API Public Methods are clearly marked in the source library

  • Inject one (or more) of several pre packed data sinks on initialization, or write your own

  • All internal references are safe from LabVIEW reference cleanup - the 'Done Global Log' must be called to close the logger or it will continue to run after closing your application.

Examples

A basic test panel and simple use example is included in the package.

Running the tests

A complete set of VI Tester unit and integration tests is inlcuded with the package. Use the VI Tester interface to run the tests - VI Tester is not required to use the package.

Notes

The network sink library and functionality is not yet ready for use.

Contribution Guidelines

All contributions must adhere to SOLID design principals.

All code must be unit tested to the extent reasonably possible.

Please contact the author if you want to contribute.

Who do I talk to?

  • Paul Ross|Composed Systems LLC
  • paul.ross@composedsystems.com

License

See the LICENSE.md file for details

Acknowledgments

  • This package is rooted in an earlier package written by Jon Mcbee
  • Many components were influenced by logging facilities in other programming languages, and example loggers provided by the LabVIEW community
  • Updated folder structure to match CS conventions, diagram disabled all broken code
  • added delayed stop
  • Added support for local log instance, updated Public API documentation

Version 0.3.0

  • This version requires LabVIEW 2017 SP1 or later.
  • Initialize Global Log.vi and Initialize Local Log.vi were both updated to malleable VIs to allow input of an array of sinks, or a single sink.
  • The connector pane layout on Initialize Global Log.vim, Initialize Local Log.vim, Log if Error.vi, Log Event.vi and Add Sink.vi has changed from Version 0.2.0 and will need to be relinked in any applications.

Version 0.4.0

  • Initialize Global Log.vim and Initialize Local Log.vim were updated to allow adding an single active sink, or an array of active sinks.
  • Add Sink.vi was updated to a malleable VI to allow input of a single active sink, or an array of sinks, in addition to a single/array of uninitialized sink(s).

Version 0.5.0

  • Seperated out the singleton and local log behaviors into seperate APIs. Any calls to log events, log if error, or add sink will now be broken if not wired with a log instance reference.
  • Added ability to launch a log with a parent log
  • Removed the ability to add an existing sink to a log - with the ability to add aggregate logs it is likely no longer useful.

Version 0.5.1

  • Fixed bug to ensure logger is NOT launched on invalid inputs

Version 0.5.2

  • Republish in 2017 SP1
  • Added malleable interface test

Version 0.5.3

  • Removed unused code

Version 0.5.4

  • Moved shared typedefs to shared library location outside class

Version 0.5.5

  • Moved additional typedefs to shared folder
  • Changed access scoping of internal methods

Version 0.5.9

  • Move Main API methods into logger reference class

Version 0.5.18

  • Removed currently unused network sink related functionality

Version 0.5.19

  • Added injectable log filters - this feature is largely untested as of yet
  • Updated sink error handling behaviors - sinks can report errors and shutdown, ignore errors and continue, or shutdown without reporting errors
  • Added console view sink - some features are still in process, and the design of this sink may change
  • Added new string format that allows a user specified string to define log entry format
  • Updated Logger behavior - if a valid instance of the logger is NOT created (by running initialize local log without valid inputs) further calls to the logger will NOT return errors
  • Added 'Get Logger Status' method to check if a logger is running and if it is a valid instance

Version 0.5.20

  • Fixed Broken examples

Version 0.6.0

  • Reworked console view and added high level show/hide/close API
  • Added new API method 'Log Value Event'
 MIT License



Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
How do I use this package?
Published by paulr 29 days ago
0.6.0 is the latest release
MIT
composed.io/
bitbucket.org/composedsystems/composed-event-logger.git
Stats
216 downloads.
Keywords
Dependencies (0)
    none