Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Oct 19, 2024
1 parent 1cfb6e1 commit 6dea5e9
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 27 deletions.
77 changes: 58 additions & 19 deletions docs/plugins/logging/gelf.html
Original file line number Diff line number Diff line change
Expand Up @@ -542,38 +542,77 @@ <h2 id="local-debugging">Local Debugging</h2>
<li>Credentials: admin/admin</li>
<li>Create a UDP input on port 12201 and set <code>GelfLoggerOptions.Host</code> to <code>localhost</code>.</li>
</ul>
<div class="NOTE"><h5>Note</h5><p>The username and password are both <code>admin</code>. This should only be used for local testing. If putting this into production be sure to update the password.</p>
</div>
<pre><code class="lang-docker">services:
mongo:
image: mongo:4.2
mongodb:
image: mongo:4.4
container_name: graylog-mongodb
restart: always
volumes:
- /docker/graylog/data/mongodb:/data/db
networks:
- graylog-network

elasticsearch:
image: docker.elastic.co/elasticsearch/elasticsearch-oss:7.10.0
image: docker.elastic.co/elasticsearch/elasticsearch:7.17.9
container_name: graylog-elasticsearch
restart: always
environment:
- http.host=0.0.0.0
- transport.host=localhost
- discovery.type=single-node
- ES_JAVA_OPTS=-Xms1g -Xmx1g
- xpack.security.enabled=false
- xpack.monitoring.enabled=false
- xpack.ml.enabled=false
- network.host=0.0.0.0
- &quot;ES_JAVA_OPTS=-Xms512m -Xmx512m&quot;
ulimits:
memlock:
soft: -1
hard: -1
volumes:
- /docker/graylog/data/elasticsearch:/usr/share/elasticsearch/data
networks:
- graylog-network

graylog:
image: graylog/graylog:4.0
environment:
- GRAYLOG_PASSWORD_SECRET=&quot;!ux*lAfQVjaRT8iI&quot;
- GRAYLOG_ROOT_PASSWORD_SHA2=8c6976e5b5410415bde908bd4dee15dfb167a9c873fc4bb8a81f6f2ab448a918
- GRAYLOG_HTTP_EXTERNAL_URI=http://localhost:9000/
entrypoint: /usr/bin/tini -- wait-for-it elasticsearch:9200 -- /docker-entrypoint.sh
image: graylog/graylog:4.3
container_name: graylog
restart: always
depends_on:
- mongo
- mongodb
- elasticsearch
environment:
- GRAYLOG_PASSWORD_SECRET=somepasswordpepper
# Password: &quot;admin&quot;
- GRAYLOG_ROOT_PASSWORD_SHA2=8c6976e5b5410415bde908bd4dee15dfb167a9c873fc4bb8a81f6f2ab448a918
- GRAYLOG_HTTP_EXTERNAL_URI=http://127.0.0.1:9000/
- GRAYLOG_ELASTICSEARCH_HOSTS=http://elasticsearch:9200
- GRAYLOG_MONGODB_URI=mongodb://mongodb:27017/graylog
ports:
- 9000:9000
- 1514:1514
- 1514:1514/udp
- 12201:12201
- 12201:12201/udp
- 12202:12202
# Graylog web interface and REST API
- &quot;9000:9000/tcp&quot;
# Beats
- &quot;5044:5044/tcp&quot;
# Syslog TCP
- &quot;5140:5140/tcp&quot;
# Syslog UDP
- &quot;5140:5140/udp&quot;
# GELF TCP
- &quot;12201:12201/tcp&quot;
# GELF UDP
- &quot;12201:12201/udp&quot;
# Forwarder data
- &quot;13301:13301/tcp&quot;
# Forwarder config
- &quot;13302:13302/tcp&quot;
volumes:
- /docker/graylog/data/graylog:/usr/share/graylog/data/journal
networks:
- graylog-network

networks:
graylog-network:
driver: bridge
</code></pre></article>
</div>

Expand Down
10 changes: 4 additions & 6 deletions docs/plugins/logging/raygun.html
Original file line number Diff line number Diff line change
Expand Up @@ -535,9 +535,7 @@ <h1 id="prism-logging-with-raygun">Prism Logging with Raygun</h1>
</code></pre><h2 id="local-development-amp-debugging">Local Development &amp; Debugging</h2>
<p>Raygun offers a free Open Source version for Crash Detection that can be run in a local environment. For more information see the <a href="https://raygun.com/documentation/product-guides/crash-reporting/local-docker-setup/">Raygun Documentation</a>.</p>
<p>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.</p>
<pre><code class="lang-docker">version: &#39;3.8&#39;

services:
<pre><code class="lang-docker">services:
raygun-aspire-portal:
image: raygunowner/raygun-aspire-portal:latest
container_name: raygun_local_dev
Expand All @@ -547,7 +545,7 @@ <h1 id="prism-logging-with-raygun">Prism Logging with Raygun</h1>
- &quot;8080:8080&quot;
restart: always
volumes:
- /localpath/raygun/errors:/app/raygun/errors
- /docker/raygun/data/errors:/app/raygun/errors
depends_on:
- ollama-service # Ensure Ollama service starts before this container

Expand All @@ -556,12 +554,12 @@ <h1 id="prism-logging-with-raygun">Prism Logging with Raygun</h1>
container_name: ollama_local_aier
restart: always
volumes:
- /localpath/ollama:/root/.ollama # Mount local directory to container for data persistence
- /docker/raygun/data/ollama:/root/.ollama # Mount local directory to container for data persistence
</code></pre><p>To use Raygun for local development with your Docker image, you can use the special extension as shown below:</p>
<pre><code class="lang-cs">container.UsePrismLogging(logging =&gt;
logging.AddLocalRaygun(&quot;http://192.168.1.11:8080/Ingestion/Entries&quot;));
</code></pre><h2 id="prismessentials-integration">Prism.Essentials Integration</h2>
<p>The Raygun Implementation of the Logger makes reference to the <a class="xref" href="../essentials/index.html">Prism.Plugin.Essentials</a> 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 <a class="xref" href="../essentials/appcontext.html">Application Context</a> from Essentials.</p>
<p>The Raygun Implementation of the Logger makes reference to the <a class="xref" href="../essentials/index.html">Prism.Plugin.Essentials</a> 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 <a class="xref" href="../essentials/appcontext.html">Application Context</a> from Essentials. In order to enable sending logs in the background with the offline store, be sure to Register Prism.Plugin.Essentials first.</p>
</article>
</div>

Expand Down
4 changes: 2 additions & 2 deletions manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -1905,7 +1905,7 @@
"output": {
".html": {
"relative_path": "docs/plugins/logging/gelf.html",
"hash": "lHw0Q2rN8k6uHl1opepg9g=="
"hash": "1XJC4Qc8M8KRgGBB3ljBbw=="
}
},
"is_incremental": false,
Expand Down Expand Up @@ -1941,7 +1941,7 @@
"output": {
".html": {
"relative_path": "docs/plugins/logging/raygun.html",
"hash": "pxG1xBUX/6gIR9ERFZPcjg=="
"hash": "nrNAHlMDhgKpAAm9RwmrOg=="
}
},
"is_incremental": false,
Expand Down

0 comments on commit 6dea5e9

Please sign in to comment.