From a5f709320650bcdad53d526a52b3d1fd4592a3b5 Mon Sep 17 00:00:00 2001 From: deepanshkhurana Date: Fri, 10 May 2024 15:48:05 +0530 Subject: [PATCH 1/4] docs: update README.md with better structure + short credit to Elkem --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 578d85a..32696d0 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,13 @@ # LogAnalyzer -The LogAnalyzer app uses the Posit Connect API to fetch logs for application run jobs, semantically colouring them so they are easier to read. +The LogAnalyzer open-source app is a simple, plug and play application developed first in collaboration with [Elkem](https://www.elkem.com/). The app provides an ability to get semantically coloured logs for applications deployed on Posit Connect by simply changing the default environment variables and deploying it on Posit Connect. Given the general usefulness of the app, we have decided to share it with the wider community to use and improve upon it. No more sifting through long text files; you can simply find the reds and see where things break. It has never been easier to investigate what goes wrong with your applications. -This was originally developed at Elkem, which made us realise that this is a pretty general purpose app which can be used by anyone. +# How it works? -The only thing you need to set this up and use is the `CONNECT_API_KEY` set as an environment variable. +- The LogAnalyzer app uses the Posit Connect API to fetch logs for application run jobs, semantically colouring them so they are easier to read. +- The only thing you need to set this up and use is the `CONNECT_API_KEY` set as an environment variable. The idea is that the key should come from either an admin account or someone with privileges to view all apps. Apps that are not available to a user will not have their logs available to them. -The API key owner should have Admin-level privileges. Else, the app may not be able to fetch jobs and logs. +# Credits +It was our collaboration with Elkem which led to the creation of this app. The initial idea came from use-cases where we realised we wanted to track all the logs and be able to read them properly since Posit Connect was the de facto deployment environment. When we made this app, we realised there was potential in sharing this with the rest of the community and invite everyone to use it and add it. We appreciate and thank Elkem for their openness to share it with the world. + +You can read more about Appsilon and Elkem's collaboration on our case study [here](https://www.appsilon.com/case-studies/refining-elkems-processes-with-advanced-data-analytics). From d7b0d246d876afffe1a16fe7e3393509c51ab5ec Mon Sep 17 00:00:00 2001 From: deepanshkhurana Date: Fri, 10 May 2024 15:57:58 +0530 Subject: [PATCH 2/4] docs: add note about CONNECT_SERVER --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 32696d0..334e9e2 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ The LogAnalyzer open-source app is a simple, plug and play application developed - The LogAnalyzer app uses the Posit Connect API to fetch logs for application run jobs, semantically colouring them so they are easier to read. - The only thing you need to set this up and use is the `CONNECT_API_KEY` set as an environment variable. The idea is that the key should come from either an admin account or someone with privileges to view all apps. Apps that are not available to a user will not have their logs available to them. +- If you want to test the app locally, you will need to set the `CONNECT_SERVER` as an environment variable. When deployed, the `CONNECT_SERVER` is setup automatically for you. # Credits It was our collaboration with Elkem which led to the creation of this app. The initial idea came from use-cases where we realised we wanted to track all the logs and be able to read them properly since Posit Connect was the de facto deployment environment. When we made this app, we realised there was potential in sharing this with the rest of the community and invite everyone to use it and add it. We appreciate and thank Elkem for their openness to share it with the world. From 277486986251a606920e98fdc6b3abf245601fdf Mon Sep 17 00:00:00 2001 From: Deepansh Khurana Date: Fri, 10 May 2024 16:04:15 +0530 Subject: [PATCH 3/4] docs: add how-to GIF to README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 334e9e2..59bc04e 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ The LogAnalyzer open-source app is a simple, plug and play application developed - The only thing you need to set this up and use is the `CONNECT_API_KEY` set as an environment variable. The idea is that the key should come from either an admin account or someone with privileges to view all apps. Apps that are not available to a user will not have their logs available to them. - If you want to test the app locally, you will need to set the `CONNECT_SERVER` as an environment variable. When deployed, the `CONNECT_SERVER` is setup automatically for you. +![LogAnalyzerDemo](https://github.com/Appsilon/LogAnalyzer/assets/26517718/90d1111d-006b-42db-8d8b-b55ee391cb21) + # Credits It was our collaboration with Elkem which led to the creation of this app. The initial idea came from use-cases where we realised we wanted to track all the logs and be able to read them properly since Posit Connect was the de facto deployment environment. When we made this app, we realised there was potential in sharing this with the rest of the community and invite everyone to use it and add it. We appreciate and thank Elkem for their openness to share it with the world. From a9df70f7b367ad45f59011decd895daa0378396d Mon Sep 17 00:00:00 2001 From: Jakub Nowicki Date: Fri, 10 May 2024 12:47:28 +0200 Subject: [PATCH 4/4] docs: Add Appsilon section to the README. --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 59bc04e..2de84ac 100644 --- a/README.md +++ b/README.md @@ -14,3 +14,18 @@ The LogAnalyzer open-source app is a simple, plug and play application developed It was our collaboration with Elkem which led to the creation of this app. The initial idea came from use-cases where we realised we wanted to track all the logs and be able to read them properly since Posit Connect was the de facto deployment environment. When we made this app, we realised there was potential in sharing this with the rest of the community and invite everyone to use it and add it. We appreciate and thank Elkem for their openness to share it with the world. You can read more about Appsilon and Elkem's collaboration on our case study [here](https://www.appsilon.com/case-studies/refining-elkems-processes-with-advanced-data-analytics). + +## Appsilon + + + +Appsilon is a **Posit (formerly RStudio) Full Service Certified Partner**.
+Learn more at [appsilon.com](https://appsilon.com). + +Get in touch [opensource@appsilon.com](mailto:opensource@appsilon.com) + +Explore the [Rhinoverse](https://rhinoverse.dev) - a family of R packages built around [Rhino](https://appsilon.github.io/rhino/)! + + + Subscribe for Shiny tutorials, exclusive articles, R/Shiny community events, and more. +