https://github.com/derveloper/gotee
like unix `tee` but for slack
https://github.com/derveloper/gotee
Last synced: about 1 year ago
JSON representation
like unix `tee` but for slack
- Host: GitHub
- URL: https://github.com/derveloper/gotee
- Owner: derveloper
- License: apache-2.0
- Created: 2020-09-05T23:01:54.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-07T21:36:25.000Z (almost 6 years ago)
- Last Synced: 2025-02-09T12:27:59.395Z (over 1 year ago)
- Language: Go
- Size: 20.5 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.adoc
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
= gotee
like unix `tee` but for slack
== usage
[source.bash]
----
Usage of bin/gotee:
-c, --channel string set the channel to post to (default "C017H70JUC8")
-h, --help print this help
----
=== examples
==== simple
Pipe `STDOUT` to slack
[source,bash]
----
echo "test" | gotee
----
Stream `STDOUT` to slack, appends new lines to message every 5 seconds
[source,bash]
----
while true; do echo test; sleep 1; done | gotee
----
==== systemd failure notifications
===== Create a gotee systemd unit file
[source,bash]
----
systemctl edit --full --force gotee@.service
----
===== Content of the gotee unit file
[source,ini]
----
[Unit]
Description=Send slack notification
[Service]
Type=oneshot
ExecStart=/usr/bin/bash -c '/usr/bin/systemctl status %i | /usr/local/bin/gotee'
----
===== Finally, add gotee as OnFailure unit
[source,ini]
----
[Unit]
...
OnFailure=gotee@%n
----
====== Notifications for all units
You can place a top-level (global) `OnFailure` in `/etc/systemd/system/service.d/10-notify-failed.conf`
== configuration
either use the environment variables `GOTEE_SLACK_TOKEN` and `GOTEE_SLACK_CHANNEL`
or place a config file in `/etc/gotee/config.yml`
[source,yaml]
----
slack_token: ""
slack_channel: "C00000000"
----
== license
[source]
----
Copyright 2020 Tristan Leo
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
----