-
Notifications
You must be signed in to change notification settings - Fork 84
Update doc for testing with syslog #232
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
|
@dependabot rebase |
|
check is stuck |
|
reopen |
Troubleshooting/README.md
Outdated
| **Note:** As of the time of writing, Podman Desktop does not support syslog log driver. The syslog option is only supported when you are running Fn Server in Docker Desktop and Rancher Desktop. | ||
| Since we've already created the 'tutorial' app, we'll have to update it using |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: If you have already created an app*
Troubleshooting/README.md
Outdated
| application: | ||
| `fn update app`. But before we do that we'll need a syslog server ready to receive log data. | ||
| There are multiple options to setup a syslog server for testing. You could look up free online |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we suggest using free syslog servers? this can lead to user data leak.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, I think we can remove it. I will fix it.
| syslog server, or you could start up a local syslog server. We will show how to run a local syslog | ||
| container for our test. | ||
| ### Run local syslog docker container |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: Can we point to official syslog documentation instead of maintaining steps here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Their doc is quite complex and too much details beyond what we need to do: https://www.rsyslog.com/doc/getting_started/index.html so I would like to keep our steps here. It is easier for our users to follow.
But I will add a link to the rsyslog doc if our users want to checkout more details.
Troubleshooting/README.md
Outdated
| `syslog_url` looks to be pointing to Papertrail so let's rerun our failing | ||
| function: | ||
| `syslog_url` looks to be pointing to our syslog container so let's rerun our failing function: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: syslog_url` is now pointing*
3e1a7bf to
3b4dcd4
Compare
The part about testing Fn Server with syslog is outdated. Papertrail does not work the same way anymore. Updated the step to use a local syslog container, which is easier to setup.