### Pioreactor Logs2Slack
This is a Pioreactor plugin to post a bioreactor's logs to a Slack channel.
### Installation
This is a two part installation.
#### 1. Setting up your Slack workspace
1. You probably want a dedicated channel for incoming logs, as it can get chatty. So go ahead
and create a dedicated channel in your Slack workspace. I've called mine `experiment_logs`.
2. In [Your Apps](https://api.slack.com/apps/), click "Create New App" -> From "Scratch". Give it a name (something descriptive, like `Pioreactor Logs2Slack`), and select the workspace.
3. On the next page, select "Incoming Webhooks", and turn "Activate" to `On`
4. Click "Add new webhook to workspace"
5. In the next section, select the channel you made in step 1. Click "Allow".
6. On the next page, under "Webhook URL", is your new webhook URL, something like `https://hooks.slack.com/services/ABC.../124...`. **Important**: this is private, don't share it with untrusted people, don't commit it into Github, etc.
#### 2. Installing this plugin
1. In your Pioreactor interface, click on "Plugins". Find `pioreactor-logs2slack`, and click "Install" beside it. **Or** you can run `pio install-plugin pioreactor-logs2slack`. Either way, this plugin will be installed on your leader Pioreactor.
2. After installing (should take less than a minute), click on "Configuration". At the bottom of the page will be a section called `[logs2slack]`.
```
[logs2slack]
slack_webhook_url=
log_level=INFO
```
Add your webhook URL from step 6. here. Click "Save". You can also change the level of logs to report, see [Python logging levels](https://docs.python.org/3/library/logging.html#logging-levels).
3. Power-cycle (reboot) the Pioreactor leader, or ssh into the Pioreactor leader and run `sudo systemctl restart pioreactor_startup_run@logs2slack.service`
4. In your dedicated Slack channel, you should start to see logs arrive!
Raw data
{
"_id": null,
"home_page": "https://github.com/Pioreactor/pioreactor-logs2slack",
"name": "pioreactor-logs2slack",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Pioreactor",
"author_email": "hello@pioreactor.com",
"download_url": null,
"platform": null,
"description": "### Pioreactor Logs2Slack\n\nThis is a Pioreactor plugin to post a bioreactor's logs to a Slack channel.\n\n### Installation\n\nThis is a two part installation.\n\n#### 1. Setting up your Slack workspace\n\n1. You probably want a dedicated channel for incoming logs, as it can get chatty. So go ahead\nand create a dedicated channel in your Slack workspace. I've called mine `experiment_logs`.\n\n2. In [Your Apps](https://api.slack.com/apps/), click \"Create New App\" -> From \"Scratch\". Give it a name (something descriptive, like `Pioreactor Logs2Slack`), and select the workspace.\n\n3. On the next page, select \"Incoming Webhooks\", and turn \"Activate\" to `On`\n\n4. Click \"Add new webhook to workspace\"\n\n5. In the next section, select the channel you made in step 1. Click \"Allow\".\n\n6. On the next page, under \"Webhook URL\", is your new webhook URL, something like `https://hooks.slack.com/services/ABC.../124...`. **Important**: this is private, don't share it with untrusted people, don't commit it into Github, etc.\n\n\n#### 2. Installing this plugin\n\n1. In your Pioreactor interface, click on \"Plugins\". Find `pioreactor-logs2slack`, and click \"Install\" beside it. **Or** you can run `pio install-plugin pioreactor-logs2slack`. Either way, this plugin will be installed on your leader Pioreactor.\n\n2. After installing (should take less than a minute), click on \"Configuration\". At the bottom of the page will be a section called `[logs2slack]`.\n\n```\n[logs2slack]\nslack_webhook_url=\nlog_level=INFO\n```\n\nAdd your webhook URL from step 6. here. Click \"Save\". You can also change the level of logs to report, see [Python logging levels](https://docs.python.org/3/library/logging.html#logging-levels).\n\n3. Power-cycle (reboot) the Pioreactor leader, or ssh into the Pioreactor leader and run `sudo systemctl restart pioreactor_startup_run@logs2slack.service`\n\n4. In your dedicated Slack channel, you should start to see logs arrive!\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Push logs generated by Pioreactors to your Slack workspace",
"version": "0.3.3",
"project_urls": {
"Homepage": "https://github.com/Pioreactor/pioreactor-logs2slack"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "926dce77093820587812320edad6e021404542836d68f25438f74830ae5c97ef",
"md5": "17f718eeb25de453944c47aaf4bb4220",
"sha256": "77be494c94385c9f1e23da7e57097b84cbd5c7a0b6d866b7da287ad02b3d69ea"
},
"downloads": -1,
"filename": "pioreactor_logs2slack-0.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "17f718eeb25de453944c47aaf4bb4220",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5525,
"upload_time": "2024-03-27T17:19:28",
"upload_time_iso_8601": "2024-03-27T17:19:28.307562Z",
"url": "https://files.pythonhosted.org/packages/92/6d/ce77093820587812320edad6e021404542836d68f25438f74830ae5c97ef/pioreactor_logs2slack-0.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-27 17:19:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Pioreactor",
"github_project": "pioreactor-logs2slack",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pioreactor-logs2slack"
}
JSON
