Deployed 4e5bcd0 with MkDocs version: 1.6.0

coralogix · May 9, 2024 · 224b42d · 224b42d
1 parent ccba587
commit 224b42d
Show file tree

Hide file tree

Showing 16 changed files with 777 additions and 71 deletions.
diff --git a/404.html b/404.html
@@ -420,7 +420,7 @@
 
 
   <span class="md-ellipsis">
-    Kubernetes (Python, Java)
+    Kubernetes Microservices+Otel Collector
   </span>
 
 

diff --git a/index.html b/index.html
@@ -369,9 +369,9 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#apm-microservices" class="md-nav__link">
+  <a href="#apm-microservices-and-opentelemetry-collector-configurations" class="md-nav__link">
     <span class="md-ellipsis">
-      APM - Microservices
+      APM - Microservices and OpenTelemetry Collector Configurations
     </span>
   </a>
 
@@ -531,7 +531,7 @@
 
 
   <span class="md-ellipsis">
-    Kubernetes (Python, Java)
+    Kubernetes Microservices+Otel Collector
   </span>
 
 
@@ -703,11 +703,13 @@ <h2 id="opentelemetry-info">OpenTelemetry Info</h2>
 <p>Coralogix uses open standard telemetry shippers and infrastructure/application metrics/traces/logs make use of OpenTelmetry  <br />
 <a href="otel/about-opentelemetry/">OpenTelemetry Overview and Value Proposition</a>  </p>
 <h2 id="workshops">Workshops</h2>
-<h3 id="apm-microservices">APM - Microservices</h3>
+<h3 id="apm-microservices-and-opentelemetry-collector-configurations">APM - Microservices and OpenTelemetry Collector Configurations</h3>
 <p><a href="otel/microservices/">Kubernetes (Python)</a><br />
 - Kubernetes OpenTelemetry Collector for metrics/traces/logs<br />
 - OpenTelemetry tracing instrumentation for containerized Python and Java apps<br />
 - Prometheus custom metrics collection<br />
+- MySQL 
+- Redis<br />
 - Sample "bad" deployment and errors  </p>
 <p><a href="otel/ecs-fargate/">AWS ECS Fargate (Python)</a><br />
 - 2x container microservice, OpenTelemetry Collector, Firelens log router<br />

diff --git a/otel/about-opentelemetry/index.html b/otel/about-opentelemetry/index.html
@@ -490,7 +490,7 @@
 
 
   <span class="md-ellipsis">
-    Kubernetes (Python, Java)
+    Kubernetes Microservices+Otel Collector
   </span>
 
 

diff --git a/otel/ecs-ec2/index.html b/otel/ecs-ec2/index.html
@@ -436,7 +436,7 @@
 
 
   <span class="md-ellipsis">
-    Kubernetes (Python, Java)
+    Kubernetes Microservices+Otel Collector
   </span>
 
 

diff --git a/otel/ecs-fargate/index.html b/otel/ecs-fargate/index.html
@@ -436,7 +436,7 @@
 
 
   <span class="md-ellipsis">
-    Kubernetes (Python, Java)
+    Kubernetes Microservices+Otel Collector
   </span>
 
 
@@ -527,36 +527,54 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#step-3-prep-requirements" class="md-nav__link">
+  <a href="#step-3-deploy-the-example-mysql-database-deployment" class="md-nav__link">
     <span class="md-ellipsis">
-      Step 3: Prep Requirements
+      Step 3 - Deploy the example MySQL database deployment
     </span>
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#step-4-prep-register-task" class="md-nav__link">
+  <a href="#step-4-deploy-the-otel-collector-mysql-receiver" class="md-nav__link">
     <span class="md-ellipsis">
-      Step 4: Prep / Register Task
+      Step 4 - Deploy the Otel Collector MySQL Receiver
     </span>
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#step-5-launch-task" class="md-nav__link">
+  <a href="#step-5-deploy-the-otel-sql-query-receiver-example" class="md-nav__link">
     <span class="md-ellipsis">
-      Step 5: Launch Task
+      Step 5 - Deploy the Otel SQL Query receiver Example
     </span>
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#step-6-study-results-in-coralogix-portal" class="md-nav__link">
+  <a href="#step-6-upload-dashboard-example-to-custom-dashboards" class="md-nav__link">
     <span class="md-ellipsis">
-      Step 6 - Study results in Coralogix portal
+      Step 6 - Upload dashboard example to Custom Dashboards
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#step-7-study-deployment-examples" class="md-nav__link">
+    <span class="md-ellipsis">
+      Step 7 - Study deployment examples
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#step-8-cleanup" class="md-nav__link">
+    <span class="md-ellipsis">
+      Step 8 - Cleanup
     </span>
   </a>
 
@@ -708,45 +726,38 @@
 
 <h1 id="opentelemetry-for-aws-ecs-fargate">OpenTelemetry for AWS ECS-Fargate</h1>
 <h2 id="instructions">Instructions</h2>
-<p>This example is for basic study only and is not documentation.  <br />
-Full documentation: <a href="https://coralogix.com/docs/">https://coralogix.com/docs/</a><br />
-Requirements:<br />
-- AWS Account
-- Intermediate to Advanced skill with ECS-Fargate<br />
-- Sufficient permissions to configure AWS<br />
-- Proper IDE i.e. Visual Studio Code </p>
+<p>Complete the Microservices Workshop or install the OpenTelemetry Collector on your k8s cluster  </p>
+<p><a href="https://coralogix.com/docs/otel-collector-for-k8s/">Easy Coralogix instructions for Complete Observability are here</a>  </p>
 <h3 id="step-1-setup">Step 1 - Setup</h3>
-<p>Clone repo:</p>
+<p>Clone repo or use existing clone of it:</p>
 <pre><code>git clone https://github.com/coralogix/workshops
 </code></pre>
 <h3 id="step-2-change-to-workshop-dir">Step 2 - Change to workshop dir</h3>
 <p>Change to the proper directory for workshop example:  </p>
-<pre><code>cd ./workshops/workshops/otel/ecs-fargate
+<pre><code>cd ./workshops/workshops/otel/microservices
 </code></pre>
-<h3 id="step-3-prep-requirements">Step 3: Prep Requirements</h3>
-<p>1 - Put the following file in an S3 bucket:<br />
-https://github.com/coralogix/telemetry-shippers/blob/master/logs/fluent-bit/ecs-fargate/base_filters.conf  </p>
-<p>2 - Put the following in a Systems Manager Parameter Store:<br />
-https://github.com/coralogix/telemetry-shippers/blob/master/otel-ecs-fargate/config.yaml  </p>
-<p>3 - Create a role called <code>ecsTaskExecutionRole</code><br />
-that contains the AWS managed <code>AmazonECSTaskExecutionRolePolicy</code><br />
-and two example policies from this workshop:<br />
-<code>ecs-policy-s3-access.json</code><br />
-<code>ecs-policy-secrets-access.json</code>  </p>
-<p>These two policies should be tuned for your own production security needs when going into production.  </p>
-<h3 id="step-4-prep-register-task">Step 4: Prep / Register Task</h3>
-<p>Prep example Task: <code>aws-fargate-otel-demo.json</code> </p>
-<p>Update all 14 locations replacing contents bewteen <code>&lt; &gt;</code> and removing those brackets but leaving the quotes: adding task execution role, key, domain, S3 ARN, Systems Parameter etc...  </p>
-<p>Once prepped the task can be registered and made into a service.  </p>
-<h3 id="step-5-launch-task">Step 5: Launch Task</h3>
-<p>Launch according to your standard procedure.  </p>
-<p>The task creates the following containers:<br />
-- two microservices (Client/Server)<br />
-- FireLens log router<br />
-- Otel collector  </p>
-<p>The microservice containers create a Python HTTP client and server that will generate spans and logs and send to Coralogix.  </p>
-<h3 id="step-6-study-results-in-coralogix-portal">Step 6 - Study results in Coralogix portal</h3>
-<p>The shell scripts show how a the microservices example.</p>
+<h3 id="step-3-deploy-the-example-mysql-database-deployment">Step 3 - Deploy the example MySQL database deployment</h3>
+<p>In: <code>mysql/mysqld</code><br />
+<code>source deploy-mysqld.sh</code> </p>
+<h3 id="step-4-deploy-the-otel-collector-mysql-receiver">Step 4 - Deploy the Otel Collector MySQL Receiver</h3>
+<p>In <code>mysql/mysqlreceiver</code><br />
+<code>source deploy-override.sh</code>  </p>
+<h3 id="step-5-deploy-the-otel-sql-query-receiver-example">Step 5 - Deploy the Otel SQL Query receiver Example</h3>
+<p>In <code>mysql/mysqlqueryreceiver</code><br />
+<code>source deploy-override.sh</code>  </p>
+<h3 id="step-6-upload-dashboard-example-to-custom-dashboards">Step 6 - Upload dashboard example to Custom Dashboards</h3>
+<p><em>Coralogix-&gt;Dashboards-&gt;Custom Dashboards-&gt;New-&gt;Import</em>  </p>
+<p>Import: <code>mysql/dashboard.json</code>  </p>
+<h3 id="step-7-study-deployment-examples">Step 7 - Study deployment examples</h3>
+<p><code>mysqlreceiver</code> - override yaml shows the MySQL receiver configuration example  </p>
+<p><code>sqlqueryreceiver</code> - override yaml shows the SQL synthetic query configuration example  </p>
+<p>Observability samples of both are shown on the MySQL Custom Dashboard  </p>
+<h3 id="step-8-cleanup">Step 8 - Cleanup</h3>
+<p>Roll back to remove receivers:<br />
+<code>helm rollback otel-coralogix-integration 1</code> (or your proper previous version) </p>
+<p>Delete the sample MySQL Database:<br />
+In: <code>mysql/mysqld</code><br />
+<code>source delete-mysqld.sh</code>   </p>
 
 
 

diff --git a/otel/logparsing/logparsing/index.html b/otel/logparsing/logparsing/index.html
@@ -427,7 +427,7 @@
 
 
   <span class="md-ellipsis">
-    Kubernetes (Python, Java)
+    Kubernetes Microservices+Otel Collector
   </span>
 
 

diff --git a/otel/microservices/index.html b/otel/microservices/index.html
@@ -26,7 +26,7 @@
 
 
 
-        <title>Kubernetes (Python, Java) - Coralogix Workshops</title>
+        <title>Kubernetes Microservices+Otel Collector - Coralogix Workshops</title>
 
 
 
@@ -113,7 +113,7 @@
         <div class="md-header__topic" data-md-component="header-topic">
           <span class="md-ellipsis">
 
-              Kubernetes (Python, Java)
+              Kubernetes Microservices+Otel Collector
 
           </span>
         </div>
@@ -445,7 +445,7 @@
 
 
   <span class="md-ellipsis">
-    Kubernetes (Python, Java)
+    Kubernetes Microservices+Otel Collector
   </span>
 
 
@@ -456,7 +456,7 @@
 
 
   <span class="md-ellipsis">
-    Kubernetes (Python, Java)
+    Kubernetes Microservices+Otel Collector
   </span>
 
 

diff --git a/otel/monolith/node/index.html b/otel/monolith/node/index.html
@@ -436,7 +436,7 @@
 
 
   <span class="md-ellipsis">
-    Kubernetes (Python, Java)
+    Kubernetes Microservices+Otel Collector
   </span>
 
 

diff --git a/otel/monolith/python/index.html b/otel/monolith/python/index.html
@@ -436,7 +436,7 @@
 
 
   <span class="md-ellipsis">
-    Kubernetes (Python, Java)
+    Kubernetes Microservices+Otel Collector
   </span>
 
 

diff --git a/otel/monolith/windows/index.html b/otel/monolith/windows/index.html
@@ -436,7 +436,7 @@
 
 
   <span class="md-ellipsis">
-    Kubernetes (Python, Java)
+    Kubernetes Microservices+Otel Collector
   </span>
-Original file line number
+Diff line change
@@ Expand Up / @@ -420,7 +420,7 @@ @@
       <span class="md-ellipsis">
-        Kubernetes (Python, Java)
+        Kubernetes Microservices+Otel Collector
       </span>
@@ Expand Down @@