Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/doron050/logdna-for-all
Connect your Zeit Now projects with LogDNA
https://github.com/doron050/logdna-for-all
logdna logging monitoring serverless zeit zeit-now
Last synced: 3 months ago
JSON representation
Connect your Zeit Now projects with LogDNA
- Host: GitHub
- URL: https://github.com/doron050/logdna-for-all
- Owner: doron050
- License: mit
- Created: 2019-05-28T18:14:34.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T17:59:54.000Z (about 2 years ago)
- Last Synced: 2024-07-30T21:07:53.589Z (6 months ago)
- Topics: logdna, logging, monitoring, serverless, zeit, zeit-now
- Language: JavaScript
- Homepage: https://zeit.co/integrations/logdna-for-all
- Size: 13.9 MB
- Stars: 6
- Watchers: 3
- Forks: 3
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
LogDNA ZEIT Integration
Connect your ZEIT Now Projects to LogDNA
Say goodbye to loggers!
• Our Vision
• Key Features
• How to Use
• Dev Setup
• Contact
• LogDNA
• ZEIT
> *LogDNA For All* - `be smart`, `take responsibility`.
[](https://forthebadge.com)
[](https://forthebadge.com)
> **We are making our best efforts** to bring you the best logging integrations.
> If you like our integration, you can help us by donate and become a backer.
:fireworks: [Try it out!](https://zeit.co/integrations/logdna-for-all) :fireworks:
## Our Vision
> Allow **every developer** to **_take responsibility_** over their creation by delivering **_the best integration_**
to connect their project for _logging:chart_with_upwards_trend: & monitoring:traffic_light: service.
## Key Features
* Integrate your ZEIT Now project with LogDNA :electric_plug:
* Connect team projects :family:
* Connect user projects :bowtie:
* Consistently transfer all your logs to your LogDNA project
#### Screenshot - Integration Configuration:
#### Screenshot - LogDNA:
## How to Use
* **Select one of the following:**
* **The fastest way** :rocket: - Go [here](https://zeit.co/integrations/logdna-for-all/add)
* `Or` Go to [Our integration page](https://zeit.co/integrations/logdna-for-all)
* Press `add`
* `Or manually` :hand: Go to the [marketplace](https://zeit.co/integrations):
* Go to `[logging category](https://zeit.co/integrations?category=logging)`
* select our integration `LogDNA`
* Select which workspaces you want to connect to LogDNA - `User or teams`
* Press `add`
* For each project of your workspaces that you want to connect:
* Insert your *LogDNA token* :key: (get it via your project page on [LogDNA](https://logdna.com/)
* Press `Connect`
* Now you are ready to go by yourself. Enjoy! :tada:
> We hope you have _the great Logging & Monitoring Experience of your life!_ :rainbow:
## Setup for Development
In order to contribute you will need the following accounts :bookmark::
* ZEIT
* MongoDB Cloud
* LogDNA
#### Get our code ####
```bash
# Clone this repository
$ git clone https://github.com/doron050/logdna-for-all.git
# Go into the repository
$ cd logdna-for-all
# Install dependencies
$ npm install
```
#### ZEIT integrations ####
* Follow the instructions on the ZEIT Integrations documentation to setup your integration
* On your integration settings page:
* Leave the `redirect url` empty
* Set the `ui-hook url` to: http://localhost:5005/ui-hooks
* Go to your integration page and add it to your user/team
* Add your logDNA token :key:
#### MongoDB cloud ####
* Register for MongoDB cloud
* Create your cluster and get the connection details :bookmark_tabs:
* Make sure you set your `.env` file :pencil2::
```diff
# DB
+ DB_USER_NAME=[your mongodb cloud user name]
+ DB_PASSWORD=[your mongodb cloud password]
+ DB_URL=[your mongodb url]
+ DB_SCHEME=[your mongodb scheme]
+ DB_NAME=[your mongodb db name]
+ DB_COLLECTION_NAME=[your mongodb collection name]
```
#### Advanced .env ####
Specify what environment you are targeting:
```diff
# ENV
+ ENVIRONMENT=[production / development]
```
If you want to, you can control some of our intervals :clock1::
```diff
+ CONSUME_PROJECT_LOG_INTERVAL=[time between reading and sending logs - default is 3000]
+ SYNC_SUBSCRIBER_WITH_DB_INTERVAL=[time between sync with the metadata inside the db - default is 6000]
```
If you want your integration to send logs to [LogzIO]() you need to configure this setting:
```diff
# LOGGER
+ LOGGER_TOKEN=[LogzIO token]
```
#### Run the integration ####
* Run your integration locally using `npm run zeit`
* Use your browser and go to your integration configuration page :scroll:
* You should now see the integration configuration page _(it is connected to your localhost)_
_**:warning:notice!**_
> If you want to debug and change the configuration UI you are good to go!
> Every configuration you create will be saved inside your database. You use this data in the following background node app.
#### Run your background node app ####
_**:warning:notice!**_
> Since we cannot use our localhost as the redirect endpoint for the oauth proccess
you will miss 2 critical fields on every database document (ZeitToken, teamId) :sweat:
In order to get over it :muscle::
* Upload your app to ZEIT using the `now` command (the `now.json` file is provided for you) :outbox_tray:
* Set your integrations `redirect url` to `/redirect`
* Set the following `secret`s :closed_lock_with_key::
```diff
# Zeit
+ INTEGRATION_CLIENT_ID=[Your app auth client id]
+ INTEGRATION_CLIENT_SECRET=[Your app secret]
```
* Now you should follow the How to Use steps in order to use your integration :sweat_smile:
_**Now you can run the background node!**_
* Use `npm start` in order to start the sync
Have fun. Keep Coding. :computer:
### Our Team
------
### Support and Contact
------
**LogDNA-For-All** © 2019+, DE, MB, NM Released under the [MIT License].
Authored and maintained by DE, MB, NM. with help from contributors.
> GitHub [@Niv](https://github.com/nivm1)
> GitHub [@Doron Eli](https://github.com/doron050)
> GitHub [@Moshe Basher](https://github.com/moshebasher)
> Contact us via mail:
[MIT License]: http://mit-license.org/