search

mattermost / mattermost-developer-documentation

Mattermost developer documentation.
https://developers.mattermost.com
BSD 3-Clause "New" or "Revised" License
80 stars 383 forks source link

Help Wanted: Document how to use `tail` and `jq` to parse plugin and App framework logs #1197

Open mm-cloud-bot opened 1 year ago

mm-cloud-bot commented 1 year ago

Mattermost user michael.kochell from https://community.mattermost.com has requested the following be documented:

As noted in this thread [<jump to convo>](/core/pl/8k8hd3xf3bfutgfwrs9cfypafo) - https://community.mattermost.com/core/pl/8k8hd3xf3bfutgfwrs9cfypafo, we can use the commands `tail` and `jq` together to parse Mattermost logs while the server is running. We can filter out logs for the App framework using this:

```sh
tail -f mattermost.log | jq -c 'select(.plugin_id=="com.mattermost.apps")'


See the original post [here](https://community.mattermost.com/_redirect/pl/papig1g3xtrwpdrti33ug9i87e).

_This issue was generated from [Mattermost](https://mattermost.com) using the [Doc Up](https://github.com/jwilander/mattermost-plugin-docup) plugin._
cwarnermm commented 1 year ago

@asatkinson - Do you have a resource available to help draft a dev docs update to address this request?

Rutam21 commented 5 months ago

@cwarnermm I would like to take this up, Is there a specific Doc section that should have this documented? Please let me know and feel free to add any additional details to help me solve this. Thanks.

cc: @mickmister

mickmister commented 5 months ago

Hi @Rutam21! I think adding a new section called "Development Tips" (@cwarnermm does that sound okay?) to this page makes sense https://developers.mattermost.com/integrate/apps/quickstart