Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/newrelic-experimental/slacklogsintegration
https://github.com/newrelic-experimental/slacklogsintegration
nrlabs nrlabs-data nrlabs-odp observability-data
Last synced: about 20 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/newrelic-experimental/slacklogsintegration
- Owner: newrelic-experimental
- License: apache-2.0
- Created: 2023-09-19T17:41:21.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-01T12:09:39.000Z (10 months ago)
- Last Synced: 2024-04-16T19:00:40.856Z (7 months ago)
- Topics: nrlabs, nrlabs-data, nrlabs-odp, observability-data
- Language: Go
- Homepage:
- Size: 519 KB
- Stars: 0
- Watchers: 9
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Support: SUPPORT.md
Awesome Lists containing this project
README
# Slack Logs to New Relic Log API
Send following Slack API logs to New Relic's Log API. 🚧 This project is currently work in progress and supports following logs collection
- [ChannelDetail](https://api.slack.com/methods/conversations.list)
- [UserLogs](https://api.slack.com/methods/users.list)
- [AccessLogs](https://api.slack.com/methods/team.accessLogs)
- [ConversationLogs](https://api.slack.com/methods/conversations.history)
- [AuditLogs](https://api.slack.com/admins/audit-logs)
### Prerequisites
- Install Slack app with required permissions and collect user token. Use this token as a SLACK_ACCESS_TOKEN system variable. Currently, SlackLogsIntegration requires following permissions.
```admin, users:read, channels:read, teams:read, channels:history, auditlogs:read ```
Please [refer Development](#Development) if you need help to create a Slack app.
- Get New Relic ingest key. Use this key as a INGEST_KEY system variable.
- Review SlackCongif.yaml in the repository and modify configuration accordingly.
### Installation
Slack logs integration can be installed in two ways
#### Option 1: Docker Container
- Build docker image using [Dockerfile](https://github.com/newrelic-experimental/SlackLogsIntegration/blob/main/Dockerfile)
( `docker build --no-cache --tag slack-logger .` )
- Refer [Configuration](#configuration) for available config options
- Start the application in side the container, with required params
```bash
docker run -e SLACK_ACCESS_TOKEN= -e INGEST_KEY= slack-logger
```
#### Option 2: Standalone binary
- Build binary from the source code
```bash
git clone https://github.com/newrelic-experimental/SlackLogsIntegration.git
cd SlackLogsIntegration
GOARCH=amd64 GOOS=linux go build -o /slackLogger internal/main.go
```
- Refer [Configuration](#configuration) for available config options
- ` export SLACK_ACCESS_TOKEN= `
- ` export INGEST_KEY= `
- Start application directly on host
```bash
/slackLogger
```
### Configuration
Configuration ```SlackConfig.yaml``` with defaults is self-describing for this application:
```bash
global:
flushLogSize: 1MB
logAPIEndPoint: https://log-api.newrelic.com/log/v1
logLevel: info
conversationLogs:
enabled: True
pollingInterval: 5m
channelDetails:
enabled: True
pollingInterval: 6h
userLogs:
enabled: True
pollingInterval: 24m
accessLogs:
enabled: True
pollingInterval: 5m
auditLogs:
enabled: True
pollingInterval: 5m
```
### Browse your Log data in NR
- [Login into One New Relic](https://one.newrelic.com)
- Open `Query Your Data` 
- Query the data using NRQL 
- select * from Log where logtype='ChannelDetail' since 1 day ago
## Troubleshooting
- Please check whether Slack app has installed with proper permissions.
- Audit logs can be collected only using organisation wide access token
- Please refer FAQ[https://github.com/newrelic-experimental/SlackLogsIntegration/blob/update-readme/FAQ.txt]
## Development
- [Create a new Slack APP](https://api.slack.com/start/quickstart)
- [Slack App home page](https://api.slack.com/apps)
- [Create a new Slack APP on Enterprise grid](https://api.slack.com/enterprise/grid)
- [Slack access token authentication](https://api.slack.com/authentication/oauth-v2)
- Verify token validay by triggering respective [API call](https://api.slack.com/methods/conversations.list/test)
## Support
New Relic has open-sourced this project. This project is provided AS-IS WITHOUT WARRANTY OR DEDICATED SUPPORT. Issues and contributions should be reported to the project here on GitHub.
We encourage you to bring your experiences and questions to the [Explorers Hub](https://discuss.newrelic.com) where our community members collaborate on solutions and new ideas.
## Contributing
We encourage your contributions to improve this project! Keep in mind when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project. If you have
any questions, or to execute our corporate CLA, required if your contribution is on behalf of a company, please drop us an email at [email protected].
**A note about vulnerabilities**
As noted in our [security policy](../../security/policy), New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals.
If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through [HackerOne](https://hackerone.com/newrelic).
## License
This project is licensed under the [Apache 2.0](http://apache.org/licenses/LICENSE-2.0.txt) License.