# A log forwarder for the IBM Z HMC
[](https://pypi.python.org/pypi/zhmc-log-forwarder/)
[](https://readthedocs.org/projects/zhmc-log-forwarder/builds/)
[](https://github.com/zhmcclient/zhmc-log-forwarder/actions/workflows/test.yml?query=branch%3Amaster)
[](https://coveralls.io/github/zhmcclient/zhmc-log-forwarder?branch=master)
# Overview
The zhmc-log-forwarder package provides a log forwarder for the
[IBM Z](https://www.ibm.com/it-infrastructure/z) Hardware Management Console
(HMC), written in pure Python.
It contains a command named `zhmc_log_forwarder` that collects security
logs and audit logs from the Z HMC and forwards the log entries to
various destinations, such as stdout, the local syslog, or a QRadar
service.
The command can gather log entries from the past, since a specified date
and time, or since specific points such as now or all available entries.
The command can in addition subscribe for notifications from the HMC
about new log entries, so that it can wait for any future log entries to
appear.
The log forwarder supports the following destinations:
- Standard output
- Standard error
- rsyslog server
and the following formats:
- Single line format
- [Cloud Auditing Data Federation](https://www.dmtf.org/standards/cadf) (CADF)
format, represented as a JSON string
# Installation
``` text
$ pip install zhmc-log-forwarder
```
This will install the package and all of its prerequisite packages into
your current Python environment.
It is recommended to use a virtual Python environment, in order not to
clutter up your system Python.
# Quickstart
1. Make sure you installed the zhmc-log-forwarder package (see the
previous section).
2. Create a config file for the `zhmc_log_forwarder` command. The
config file specifies the targeted HMC, the desired destination for
the logs, and other data.
An example config file with explanations of the parameters is shown
when invoking:
``` text
$ zhmc_log_forwarder --help-config-file
```
Additionally, an example config file is here:
[example_config_file.yml](https://github.com/zhmcclient/zhmc-log-forwarder/blob/master/example_config_file.yml)
Redirect that output into a file and edit that file as needed.
3. Optional: The zhmc-log-forwarder package includes a default HMC log
message file. That file is used when generating CADF output format
and defines how the HMC log messages are classified in the CADF
output. It is possible to specify your own HMC log message file
using the `log_message_file` parameter in the config file. When
omitting this parameter, or when setting it to `null`, the default
HMC log message file included with the zhmc-log-forwarder package is
used.
An example HMC log message file explaining its format is shown when
invoking:
``` text
$ zhmc_log_forwarder --help-log-message-file
```
4. Start the `zhmc_log_forwarder` command as follows:
``` text
$ zhmc_log_forwarder -c CONFIGFILE
```
Where `CONFIGFILE` is the file path of the created config file.
The command will run forever (or until stopped with Ctrl-C) and will
forward the log records as specified in the config file.
# Documentation and Change Log
- [Documentation](http://zhmc-log-forwarder.readthedocs.io)
- [Change log](http://zhmc-log-forwarder.readthedocs.io/en/master/changes.html)
# License
The zhmc-log-forwarder package is licensed under the [Apache 2.0
License](https://github.com/zhmcclient/zhmc-log-forwarder/tree/master/LICENSE).
Raw data
{
"_id": null,
"home_page": null,
"name": "zhmc-log-forwarder",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Andreas Maier <maiera@de.ibm.com>",
"keywords": "hmc, prometheus, monitoring",
"author": null,
"author_email": "Andreas Maier <maiera@de.ibm.com>",
"download_url": "https://files.pythonhosted.org/packages/3f/69/982ee95be22686548ab6a6b55fdb6a9b601a4264b200f925b3997d262674/zhmc_log_forwarder-1.0.0.tar.gz",
"platform": "any",
"description": "# A log forwarder for the IBM Z HMC\n\n[](https://pypi.python.org/pypi/zhmc-log-forwarder/)\n[](https://readthedocs.org/projects/zhmc-log-forwarder/builds/)\n[](https://github.com/zhmcclient/zhmc-log-forwarder/actions/workflows/test.yml?query=branch%3Amaster)\n[](https://coveralls.io/github/zhmcclient/zhmc-log-forwarder?branch=master)\n\n# Overview\n\nThe zhmc-log-forwarder package provides a log forwarder for the\n[IBM Z](https://www.ibm.com/it-infrastructure/z) Hardware Management Console\n(HMC), written in pure Python.\n\nIt contains a command named `zhmc_log_forwarder` that collects security\nlogs and audit logs from the Z HMC and forwards the log entries to\nvarious destinations, such as stdout, the local syslog, or a QRadar\nservice.\n\nThe command can gather log entries from the past, since a specified date\nand time, or since specific points such as now or all available entries.\nThe command can in addition subscribe for notifications from the HMC\nabout new log entries, so that it can wait for any future log entries to\nappear.\n\nThe log forwarder supports the following destinations:\n\n- Standard output\n- Standard error\n- rsyslog server\n\nand the following formats:\n\n- Single line format\n- [Cloud Auditing Data Federation](https://www.dmtf.org/standards/cadf) (CADF)\n format, represented as a JSON string\n\n\n# Installation\n\n``` text\n$ pip install zhmc-log-forwarder\n```\n\nThis will install the package and all of its prerequisite packages into\nyour current Python environment.\n\nIt is recommended to use a virtual Python environment, in order not to\nclutter up your system Python.\n\n# Quickstart\n\n1. Make sure you installed the zhmc-log-forwarder package (see the\n previous section).\n\n2. Create a config file for the `zhmc_log_forwarder` command. The\n config file specifies the targeted HMC, the desired destination for\n the logs, and other data.\n\n An example config file with explanations of the parameters is shown\n when invoking:\n\n ``` text\n $ zhmc_log_forwarder --help-config-file\n ```\n\n Additionally, an example config file is here:\n [example_config_file.yml](https://github.com/zhmcclient/zhmc-log-forwarder/blob/master/example_config_file.yml)\n\n Redirect that output into a file and edit that file as needed.\n\n3. Optional: The zhmc-log-forwarder package includes a default HMC log\n message file. That file is used when generating CADF output format\n and defines how the HMC log messages are classified in the CADF\n output. It is possible to specify your own HMC log message file\n using the `log_message_file` parameter in the config file. When\n omitting this parameter, or when setting it to `null`, the default\n HMC log message file included with the zhmc-log-forwarder package is\n used.\n\n An example HMC log message file explaining its format is shown when\n invoking:\n\n ``` text\n $ zhmc_log_forwarder --help-log-message-file\n ```\n\n4. Start the `zhmc_log_forwarder` command as follows:\n\n ``` text\n $ zhmc_log_forwarder -c CONFIGFILE\n ```\n\n Where `CONFIGFILE` is the file path of the created config file.\n\n The command will run forever (or until stopped with Ctrl-C) and will\n forward the log records as specified in the config file.\n\n# Documentation and Change Log\n\n- [Documentation](http://zhmc-log-forwarder.readthedocs.io)\n- [Change log](http://zhmc-log-forwarder.readthedocs.io/en/master/changes.html)\n\n# License\n\nThe zhmc-log-forwarder package is licensed under the [Apache 2.0\nLicense](https://github.com/zhmcclient/zhmc-log-forwarder/tree/master/LICENSE).\n",
"bugtrack_url": null,
"license": "Apache License, Version 2.0",
"summary": "A log forwarder for the IBM Z HMC",
"version": "1.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/zhmcclient/zhmc-log-forwarder/issues",
"Changelog": "https://zhmc-log-forwarder.readthedocs.io/en/latest/changes.html",
"Documentation": "https://zhmc-log-forwarder.readthedocs.io/en/latest/",
"Homepage": "https://github.com/zhmcclient/zhmc-log-forwarder",
"Source Code": "https://github.com/zhmcclient/zhmc-log-forwarder"
},
"split_keywords": [
"hmc",
" prometheus",
" monitoring"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "085d34a450195d89610952268d32cc6dc89fa08965aaea1765519f65fd50aa68",
"md5": "0be99884f049c315b29b367d6d1feb77",
"sha256": "260bc9dfeffce1fababab221723263103e6c81b84310906ff3cf417cbe3cd3e8"
},
"downloads": -1,
"filename": "zhmc_log_forwarder-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0be99884f049c315b29b367d6d1feb77",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 31932,
"upload_time": "2024-10-10T13:33:51",
"upload_time_iso_8601": "2024-10-10T13:33:51.002252Z",
"url": "https://files.pythonhosted.org/packages/08/5d/34a450195d89610952268d32cc6dc89fa08965aaea1765519f65fd50aa68/zhmc_log_forwarder-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3f69982ee95be22686548ab6a6b55fdb6a9b601a4264b200f925b3997d262674",
"md5": "656f7df751e6ee91641ea4e5eab9ab81",
"sha256": "a5fdae3877b4d8e399ade4e5f2ca78fc100ba7395a5cd2f3b8d646913ac4cb27"
},
"downloads": -1,
"filename": "zhmc_log_forwarder-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "656f7df751e6ee91641ea4e5eab9ab81",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1538350,
"upload_time": "2024-10-10T13:33:52",
"upload_time_iso_8601": "2024-10-10T13:33:52.810684Z",
"url": "https://files.pythonhosted.org/packages/3f/69/982ee95be22686548ab6a6b55fdb6a9b601a4264b200f925b3997d262674/zhmc_log_forwarder-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-10 13:33:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zhmcclient",
"github_project": "zhmc-log-forwarder",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "zhmc-log-forwarder"
}
JSON
