{"id":14957244,"url":"https://github.com/vercel/syslogpro","last_synced_at":"2025-09-30T03:30:59.313Z","repository":{"id":65976727,"uuid":"212815675","full_name":"vercel/SyslogPro","owner":"vercel","description":"A NodeJS Syslog module with support for RFC3164, RFC5424, LEEF, and CEF formatted messages over UDP, TCP or TLS transport","archived":false,"fork":true,"pushed_at":"2020-02-12T03:10:12.000Z","size":995,"stargazers_count":10,"open_issues_count":0,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-09-27T18:01:13.729Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"cyamato/SyslogPro","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vercel.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-10-04T12:58:33.000Z","updated_at":"2024-09-17T03:35:43.000Z","dependencies_parsed_at":"2023-02-19T19:01:12.982Z","dependency_job_id":null,"html_url":"https://github.com/vercel/SyslogPro","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vercel%2FSyslogPro","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vercel%2FSyslogPro/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vercel%2FSyslogPro/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vercel%2FSyslogPro/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vercel","download_url":"https://codeload.github.com/vercel/SyslogPro/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234695676,"owners_count":18873014,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-24T13:14:25.604Z","updated_at":"2025-09-30T03:30:53.998Z","avatar_url":"https://github.com/vercel.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"SyslogPro\n=========\n[![Build Status](https://travis-ci.org/cyamato/SyslogPro.svg?branch=master)](https://travis-ci.org/cyamato/SyslogPro) \n[![Coverage Status](https://coveralls.io/repos/github/cyamato/SyslogPro/badge.svg?branch=master)](https://coveralls.io/github/cyamato/SyslogPro?branch=master)\n![](https://img.shields.io/dub/l/vibe-d.svg?style=flat)\n\n[Site](https://github.com/cyamato/SyslogPro) |\n[Docs](https://cyamato.github.io/SyslogPro/) |\n[Wiki](https://github.com/cyamato/SyslogPro/wiki \"Changelog, Roadmap, etc.\") |\n[Code of Conduct](https://js.foundation/community/code-of-conduct)\n\nA pure Javascript Syslog module with support for RFC3164, RFC5424, IBM LEEF \n(Log Event Extended Format), and HP CEF (Common Event Format) formatted \nmessages. SyslogPro has transport options for UDP, TCP, and TLS. TLS includes \nsupport for Server and Client certificate authorization. For unformatted and \nRFC messages there is support for Basic and Extended ANSI coloring. RFC5424 \nStructured Data is also included in the module. All 28 standard CEF Extensions \nare included in the default CEF class. All 45 standard LEEF Attributes are \nincluded in the default LEEF class. It is the goal of this project is for \nevery release to offer full code coverage unit testing and documentation. \n\n[Please see the full JSDoc for usage and options: \nhttps://cyamato.github.io/SyslogPro/](https://cyamato.github.io/SyslogPro/).\n\n### News\n* ⚠ Please note that at present, the 0.1.x version of the SDK \n[requires Node 10.6 or later](https://github.com/nodejs/LTS). \n* This module makes use of [ECMA-262 Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\nand the [DNS Promises API](https://nodejs.org/api/dns.html#dns_dns_promises_api). \n* APIs do not support the callback model and only return promises.\n\n### Installation\n```shell\n  npm install --save syslog-pro\n```\n\n## Usage\n```js\n  const SyslogPro = require('syslog-pro');\n  let syslog = new SyslogPro.Syslog({\n    target: 'localhost',\n    protocol: 'udp',\n    format: 'rfc5424'\n  });\n  syslog.rfc5424.info('My Message');\n```\nOptionally you can create each class or class options to pass to SyslogPro to \ncreate formatted messages or use directly\n  \n**RFC3164**\n```js\n  let rfc3164 = new SyslogPro.RFC3164({\n    applicationName: 'MyApp',\n    color: true,\n    extendedColor: true,\n    server: {\n      target: 'myServer.fqdn'\n    }\n  });\n  rfc3164.info('My Message');\n```\n\n**RFC5424**\n```js\n  let rfc5424 = new SyslogPro.RFC5424({\n    applicationName: 'MyApp',\n    timestamp: true,\n    includeStructuredData: true\n    color: true,\n    extendedColor: true,\n    server: {\n      target: 'myServer.fqdn'\n    }\n  });\n  rfc5424.info('My Message');\n```\n\n**LEEF (Log Event Extended Format)**\n```js\n  let leef = new SyslogPro.LEEF({\n    vendor: 'acme',\n    product: 'doohickey1000',\n    version: 'alpha',\n    eventId: 'hack',\n    attrabutes: {\n      cat: 'CC Databreach'\n    },\n    server: {\n      target: 'myServer.fqdn'\n    }\n  })\n      .send()\n          .then((result) =\u003e {})\n          .catch((error) =\u003e {\n            console.log(error);\n          });\n```\n\n**CEF (Common Event Format)**\n```js\n  let cef = new SyslogPro.CEF({\n    deviceVendor: 'acme',\n    deviceProduct: 'doohickey1000',\n    deviceVersion: 'alpha',\n    deviceEventClassId: 'hack',\n    name: 'My Reporting Service',\n    severity: 'High',\n    extensions: {\n      rawEvent: 'CC Databreach'\n    },\n    server: {\n      target: 'myServer.fqdn'\n    }\n  })\n      .send()\n          .then((result) =\u003e {})\n          .catch((error) =\u003e {\n            console.log(error);\n          });\n```\n\n## API\nFor more details see:\n* [JSDoc](https://cyamato.github.io/SyslogPro/) \n* [API.md](./docs/api.md)\n* [Docco.html](./docs/docco/index.html)\n* [Docco.md](./docs/docco/README.md)\n\n## Test\n```shell\n  npm test\n```\n\n## Contributing\n\nPlease try to maintain the existing coding style. Add unit tests for any new or \nchanged functionality. Lint and test your code.\n\n* [Repository](https://github.com/cyamato/SyslogPro.git)\n* [Bug Reporting](https://github.com/cyamato/SyslogPro/issues)\n* [Wiki](https://github.com/cyamato/SyslogPro/wiki)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvercel%2Fsyslogpro","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvercel%2Fsyslogpro","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvercel%2Fsyslogpro/lists"}