-
Notifications
You must be signed in to change notification settings - Fork 111
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update essentials and logging docs
- Loading branch information
Showing
10 changed files
with
155 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,6 @@ | ||
{ | ||
"cSpell.words": [ | ||
"MVVM" | ||
"MVVM", | ||
"Xunit" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
uid: Plugins.Essentials.Battery | ||
--- | ||
|
||
# Battery |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
uid: Plugins.Essentials.MainThread | ||
uid: Plugins.Essentials.Permissions | ||
--- | ||
|
||
# App Permissions | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
uid: Plugins.Logging.Raygun | ||
--- | ||
|
||
# Prism Logging with Raygun | ||
|
||
Raygun is a platform that offers analytics about managed and unmanaged exceptions within your app as well as user tracking. | ||
|
||
```cs | ||
containerRegistry.UsePrismLogging(logging => { | ||
logging.AddRaygun("RaygunApiKey"); | ||
}); | ||
``` | ||
|
||
## Local Development & Debugging | ||
|
||
Raygun offers a free Open Source version for Crash Detection that can be run in a local environment. For more information see the [Raygun Documentation](https://raygun.com/documentation/product-guides/crash-reporting/local-docker-setup/). | ||
|
||
To get started you can copy the following docker compose sample. You can set the localpath for the volumes to persist the crash data over time and ensure that the downloaded Ollama models are persisted and do not need to be downloaded again. | ||
|
||
```docker | ||
version: '3.8' | ||
services: | ||
raygun-aspire-portal: | ||
image: raygunowner/raygun-aspire-portal:latest | ||
container_name: raygun_local_dev | ||
environment: | ||
- ConnectionStrings__Ollama=http://ollama-service:11434 | ||
ports: | ||
- "8080:8080" | ||
restart: always | ||
volumes: | ||
- /localpath/raygun/errors:/app/raygun/errors | ||
depends_on: | ||
- ollama-service # Ensure Ollama service starts before this container | ||
ollama-service: | ||
image: ollama/ollama:latest | ||
container_name: ollama_local_aier | ||
restart: always | ||
volumes: | ||
- /localpath/ollama:/root/.ollama # Mount local directory to container for data persistence | ||
``` | ||
|
||
To use Raygun for local development with your Docker image, you can use the special extension as shown below: | ||
|
||
```cs | ||
container.UsePrismLogging(logging => | ||
logging.AddLocalRaygun("http://192.168.1.11:8080/Ingestion/Entries")); | ||
``` | ||
|
||
## Prism.Essentials Integration | ||
|
||
The Raygun Implementation of the Logger makes reference to the [Prism.Plugin.Essentials](xref:Plugins.Essentials.GettingStarted) library. This allows us to dynamically check if various Essentials interfaces have been registered. If they have we automatically tailor the Logger to include offline support with request caching. Additionally we will automatically update the configuration to make use of the [Application Context](xref:Plugins.Essentials.AppContext) from Essentials. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,4 +5,4 @@ | |
- name: Microsoft Extensions | ||
href: microsoft.md | ||
- name: Unit Testing | ||
href: unit-testing.md | ||
href: testing.md |