Free and source-available fair-code licensed workflow automation tool. Easily automate tasks across different services.
Find a file
Omar Ajoue c972f3dd50
Added logging to n8n (#1381)
* Added logging to n8n

This commit adds logging to n8n using the Winston library.

For now, this commit only allows logging to console (default behavior)
or file (need to pass in config via environment variables).

Other logging methods can be further implemented using hooks. These were
skipped for now as it would require adding more dependencies.

Logging level is notice by default, meaning no additional messages would
be displayed at the moment. Logging level can be set to info or debug as
well to enrich the generated logs.

The ILogger interface was added to the workflow project as it would make
it available for all other projects but the implementation was done on
the cli project.

* Lint fixes and logging level naming. Also fixed the way we use the logger as it was not working previously

* Improvements to logging framework

Using appropriate single quotes
Improving the way the logger is declared

* Improved naming for Log Types

* Removed logger global variable, replacing it by a proxy

* Add logging to CLI commands

* Remove unused GenericHelpers

* Changed back some messages to console instead of logger and added npm
shortcuts for worker and webhook

* Fix typos

* Adding basic file rotation to logs as suggested by @mutdmour

* Fixed linting issues

* Correcting comment to correctly reflect space usage

* Added settings for log files rotation

* Correcting config type from String to Number

* Changed default file settings to number

To reflect previous changes to the type

* Changed the way log messages are added to be called statically. Also minor naming improvements

* Applying latest corrections sent by @ivov

*  Some logging improvements

* Saving logs to a folder inside n8n home instead of root

* Fixed broken tests and linting

* Changed some log messages to improve formatting

* Adding quotes to names  on log messages

* Added execution and session IDs to logs. Also removed unnecessary line breaks

*  Added file caller to log messages (#1657)

This is done using callsites library which already existed
in the project as another library's dependency. So in fact
it does not add any new dependency.

* Adding logs to help debug Salesforce node

*  Add function name to logs and add more logs

*  Improve some error messages

*  Improve some more log messages

*  Rename logging env variables to match others

Co-authored-by: dali <servfrdali@yahoo.fr>
Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-05-01 22:43:01 -05:00
.github 🐳 Allow manual rpi docker image build 2021-03-25 15:16:38 +01:00
assets 📚 Add back images for README files 2020-07-08 12:29:29 +02:00
docker 🐛 Fix rpi docker image permission issue (#1587) 2021-03-26 12:16:53 +01:00
packages Added logging to n8n (#1381) 2021-05-01 22:43:01 -05:00
.dockerignore 🐳 Add .dockerignore to make docker build much faster (#1349) 2021-01-20 08:47:10 +01:00
.editorconfig enhance .editorconfig and apply formatting cleanup to last commit 2020-04-06 14:04:59 -04:00
.gitignore 🎨 Extract postgres functionality (#737) 2020-07-10 10:48:19 +02:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2019-06-23 17:48:38 +02:00
CONTRIBUTING.md Remove duplicate information (#1632) 2021-04-07 14:33:16 +02:00
CONTRIBUTOR_LICENSE_AGREEMENT.md 📚 Add Contributor License Agreement 2019-10-25 22:21:18 +02:00
lerna.json Initial commit to release 2019-06-23 12:35:23 +02:00
LICENSE.md 📚 License text fix 2020-09-15 07:55:09 +02:00
package.json Added logging to n8n (#1381) 2021-05-01 22:43:01 -05:00
README.md 🔨 Add links to changelog and breaking changes (#1362) 2021-01-20 12:09:28 +01:00

n8n - Workflow Automation Tool

n8n.io - Workflow Automation

n8n is an extendable workflow automation tool. With a fair-code distribution model, n8n will always have visible source code, be available to self-host, and allow you to add your own custom functions, logic and apps. n8n's node-based approach makes it highly versatile, enabling you to connect anything to everything.

n8n.io - Screenshot

Demo

📺 A short demo (< 3 min) which shows how to create a simple workflow which automatically sends a new Slack notification every time a Github repository received or lost a star.

Available integrations

n8n has 200+ different nodes to automate workflows. The list can be found on: https://n8n.io/nodes

Documentation

The official n8n documentation can be found under: https://docs.n8n.io

Additional information and example workflows on the n8n.io website: https://n8n.io

The changelog can be found here and the list of breaking changes here.

Usage

Start

Execute: npm run start

n8n.cloud

Sign-up for an n8n.cloud account.

While n8n.cloud and n8n are the same in terms of features, n8n.cloud provides certain conveniences such as:

  • Not having to set up and maintain your n8n instance
  • Managed OAuth for authentication
  • Easily upgrading to the newer n8n versions

Support

If you have problems or questions go to our forum, we will then try to help you asap:

https://community.n8n.io

Jobs

If you are interested in working for n8n and so shape the future of the project check out our job posts:

https://n8n.join.com

What does n8n mean and how do you pronounce it?

Short answer: It means "nodemation" and it is pronounced as n-eight-n.

Long answer: "I get that question quite often (more often than I expected) so I decided it is probably best to answer it here. While looking for a good name for the project with a free domain I realized very quickly that all the good ones I could think of were already taken. So, in the end, I chose nodemation. 'node-' in the sense that it uses a Node-View and that it uses Node.js and '-mation' for 'automation' which is what the project is supposed to help with. However, I did not like how long the name was and I could not imagine writing something that long every time in the CLI. That is when I then ended up on 'n8n'." - Jan Oberhauser, Founder and CEO, n8n.io

Development Setup

Have you found a bug 🐛 ? Or maybe you have a nice feature to contribute ? The CONTRIBUTING guide will help you get your development environment ready in minutes.

License

n8n is fair-code distributed under Apache 2.0 with Commons Clause license.

Additional information about license can be found in the FAQ.