# Rsyslog Configuration Generator
This Python application generates client-side configuration for rsyslog using RainerScript. The configuration includes defining a ruleset and applying it to monitor log files.
## Overview
This application provides two main functions:
1. **`client_ruleset_config`**: Generates an rsyslog RainerScript configuration string to define a ruleset with disk queue settings.
2. **`apply_ruleset_client`**: Generates an rsyslog RainerScript configuration string to apply a previously defined ruleset to monitor a log file using the imfile module.
## Prerequisites
- Python 3.x
- Basic understanding of rsyslog and RainerScript
## Functions
### `client_ruleset_config(rule_name, server_ip, port, protocol)`
Generates a RainerScript configuration string to define a ruleset.
**Arguments:**
- `rule_name` (str): Name of the ruleset.
- `server_ip` (str): IP address or hostname of the rsyslog server.
- `port` (int): Port number to send logs to.
- `protocol` (str): Protocol to use ('tcp' or 'udp').
**Returns:**
- `str`: RainerScript configuration string defining the ruleset.
**Example:**
```python
config = client_ruleset_config("myRuleset", "192.168.1.100", 514, "tcp")
print(config)
Raw data
{
"_id": null,
"home_page": "https://github.com/titas2003/rsyslog-client-assist.git",
"name": "rsyslog-client-assist",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Titas Majumder",
"author_email": "titas20031996@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/df/7d/e31466ff52a33dc2cf0b424af0826801a9b482c594cafb6b6a219cde9dcb/rsyslog-client-assist-0.1.1.tar.gz",
"platform": null,
"description": "# Rsyslog Configuration Generator\n\nThis Python application generates client-side configuration for rsyslog using RainerScript. The configuration includes defining a ruleset and applying it to monitor log files.\n\n## Overview\n\nThis application provides two main functions:\n\n1. **`client_ruleset_config`**: Generates an rsyslog RainerScript configuration string to define a ruleset with disk queue settings.\n2. **`apply_ruleset_client`**: Generates an rsyslog RainerScript configuration string to apply a previously defined ruleset to monitor a log file using the imfile module.\n\n## Prerequisites\n\n- Python 3.x\n- Basic understanding of rsyslog and RainerScript\n\n## Functions\n\n### `client_ruleset_config(rule_name, server_ip, port, protocol)`\n\nGenerates a RainerScript configuration string to define a ruleset.\n\n**Arguments:**\n\n- `rule_name` (str): Name of the ruleset.\n- `server_ip` (str): IP address or hostname of the rsyslog server.\n- `port` (int): Port number to send logs to.\n- `protocol` (str): Protocol to use ('tcp' or 'udp').\n\n**Returns:**\n\n- `str`: RainerScript configuration string defining the ruleset.\n\n**Example:**\n\n```python\nconfig = client_ruleset_config(\"myRuleset\", \"192.168.1.100\", 514, \"tcp\")\nprint(config)\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Generate client-side configuration for rsyslog",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/titas2003/rsyslog-client-assist.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1989fa8c0cede6a99e8fc9834c5571b09fd85c22999c4766c372b617c3e5c948",
"md5": "f002c30233ffd294f215e75f043e7d01",
"sha256": "1fc3d33830bc8245bc99d6fee47a32d7962d05e0103dc14b07480e5a915d5777"
},
"downloads": -1,
"filename": "rsyslog_client_assist-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f002c30233ffd294f215e75f043e7d01",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4101,
"upload_time": "2024-07-30T07:01:19",
"upload_time_iso_8601": "2024-07-30T07:01:19.975144Z",
"url": "https://files.pythonhosted.org/packages/19/89/fa8c0cede6a99e8fc9834c5571b09fd85c22999c4766c372b617c3e5c948/rsyslog_client_assist-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "df7de31466ff52a33dc2cf0b424af0826801a9b482c594cafb6b6a219cde9dcb",
"md5": "020905a0a26b17ab92890bc5e34f6d72",
"sha256": "990d39ff0e37f605699be3d03fa58bf2602a5259580a55fa98b64f30ca0967b9"
},
"downloads": -1,
"filename": "rsyslog-client-assist-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "020905a0a26b17ab92890bc5e34f6d72",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 2463,
"upload_time": "2024-07-30T07:01:30",
"upload_time_iso_8601": "2024-07-30T07:01:30.119499Z",
"url": "https://files.pythonhosted.org/packages/df/7d/e31466ff52a33dc2cf0b424af0826801a9b482c594cafb6b6a219cde9dcb/rsyslog-client-assist-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-30 07:01:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "titas2003",
"github_project": "rsyslog-client-assist",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "rsyslog-client-assist"
}
JSON
