# windows-eventlog

> Native win32 module to log messages to the Windows EventLog

Latest version **2.0.0** (published 2016-03-22) · 0 weekly downloads

## Install

```sh
npm install windows-eventlog
pnpm add windows-eventlog
yarn add windows-eventlog
bun add windows-eventlog
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2016-03-22 |
| First published | 2012-04-09 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 49 |
| Author | Jose Fernando Romaniello |
| Maintainers | 0x7f, jfromaniello |
| Keywords | windows, services, log, logging, logger |

## Links

- npm: https://www.npmjs.com/package/windows-eventlog
- Repository: https://github.com/jfromaniello/node-windows-eventlog
- Homepage: http://jfromaniello.github.com/node-windows-eventlog
- Issues: https://github.com/jfromaniello/node-windows-eventlog/issues
- npm.io page: https://npm.io/package/windows-eventlog

## Dependencies (2)

- [nan](https://npm.io/package/nan.md) ^2.2.0
- [bindings](https://npm.io/package/bindings.md) ^1.2.1

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 2.0.0 (latest) — 2016-03-22
- 1.0.1 — 2013-03-23
- 1.0.0 — 2013-01-31
- 0.1.4 — 2012-11-06
- 0.1.3 — 2012-11-01
- 0.1.2 — 2012-05-23
- 0.1.1 — 2012-05-02
- 0.1.0 — 2012-04-19
- 0.0.9 — 2012-04-19
- 0.0.8 — 2012-04-17
- 0.0.7 — 2012-04-17
- 0.0.6 — 2012-04-16
- 0.0.5 — 2012-04-16
- 0.0.4 — 2012-04-16
- 0.0.3 — 2012-04-10
- … 2 more at https://npm.io/package/windows-eventlog/versions

## README

# Windows Event Log Js

Native node.js module to log messages to the Windows Event Log.

## Installation

    $ npm install windows-eventlog

## Prerequisites

You need to have a compatible Visual Studio compiler installed, e.g.:

- [Visual Studio Community 2015](https://www.visualstudio.com/products/visual-studio-community-vs)
- [Visual C++ 2010 redistributable fox x86](http://www.microsoft.com/en-us/download/details.aspx?id=5555)


## Usage

When using the library like this:

```js
  var EventLog = require('windows-eventlog').EventLog;
  var myeventlog = new EventLog("MyAppName");
  myeventlog.logSync("warn", "a message");
  myeventlog.logSync("a message"); // severity defaults to "info"
  myeventlog.log("error", "a message", function(err) {
    if (err) throw err;
  });
```

you will see something like this:

![2012-04-09_1007.png](http://joseoncodecom.ipage.com/wp-content/uploads/images/2012-04-09_1007.png)

### new EventLog(source[, logName])

This creates an instance of the EventLog with the given source. You can optionally pass a logName, defaults to "Application".

If the source doesn't exist in the event log database it will be created with the givne log name.


### eventLog.log([severity,] message, callback)

This method will create an entry in the event log with the given message.

Optionally you can specify a severity a.k.a [log entry type](http://msdn.microsoft.com/es-es/library/system.diagnostics.eventlogentrytype.aspx). The possible values are "info", "warn" and "error".

### eventLog.logSync([severity,] message)

Same as `eventLog.log()` except that it blocks.

## How it works

This module is a native module using Windows' API function [ReportEvent](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363679.aspx). 

Node.js applications using this module do not require an elevated account to log to the Windows Event Log.

## License 

(The MIT License)

Copyright (c) 2012 Jose Romaniello <jfromaniello@gmail.com>

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 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.

---
_Source: https://npm.io/package/windows-eventlog · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._