add matrix template

prabhatsharma · prabhatsharma · commit 885726e895fb · 2023-04-23T16:28:39.000+05:30
diff --git a/docs/docs/ingestion/kinesis_firehose.md b/docs/docs/ingestion/kinesis_firehose.md
@@ -4,7 +4,7 @@ Amazon Cloudwatch and [many other AWS services](https://docs.aws.amazon.com/Amaz
 
 Some of the AWS logs that can be sent to Kinesis firehose are: Amazon Cloudwatch, Amazon Virtual Private Cloud flow logs, AWS Network Firewall logs, AWS WAF logs.
 
-You can configure Kinesis firehose to send logs to Zinc Cloud / Zinc Observe using below details.
+You can configure Kinesis firehose to send logs to Zinc Cloud / ZincObserve using below details.
 
 ```yaml
 HTTP endpoint: https://api.zinc.dev/aws/org_name/stream_name/_kinesis_firehose
diff --git a/docs/docs/user-guide/alerts/templates.md b/docs/docs/user-guide/alerts/templates.md
@@ -23,10 +23,13 @@ Variables which can be used in templates are:
 ## Slack
 
 ```json
-{"text": "For stream {stream_name} of organization {org_name} alert {alert_name} of type {alert_type} is active"}
+{
+  "text": "For stream {stream_name} of organization {org_name} alert {alert_name} of type {alert_type} is active"
+}
+
 ```
 
-## Alert Manager
+## Prometheus Alert Manager
 ```json
 [
     {
@@ -48,7 +51,12 @@ Variables which can be used in templates are:
 ## WeCom
 
 ```json
-{"msgtype": "text", "text": {"content": "For stream {stream_name} of organization {org_name} alert {alert_name} of type {alert_type} is active"}}
+{
+  "msgtype": "text",
+  "text": {
+    "content": "For stream {stream_name} of organization {org_name} alert {alert_name} of type {alert_type} is active"
+  }
+}
 ```
 
 Message usage:
@@ -63,7 +71,12 @@ Webhook URL, eg:
 ## Feishu
 
 ```json
-{"msg_type": "text", "content": {"text": "For stream {stream_name} of organization {org_name} alert {alert_name} of type {alert_type} is active"}}
+{
+  "msg_type": "text",
+  "content": {
+    "text": "For stream {stream_name} of organization {org_name} alert {alert_name} of type {alert_type} is active"
+  }
+}
 ```
 
 Message usage:
@@ -74,3 +87,16 @@ Webhook URL, eg:
 
 `POST https://open.feishu.cn/open-apis/bot/v2/hook/d91b7e97-1234-1234-1234-dfb0b9cc54d0`
 
+
+## Matrix
+
+```json
+{
+    "msgtype": "m.text",
+    "format": "org.matrix.custom.html",
+    "body": "{org_name}/{stream_name}: {alert_name}<br><a href=https://yourZincObserveURL.example.com/web/logs?org_identifier={org_name}>Recent logs</a>",
+    "formatted_body": "{org_name}/{stream_name}: {alert_name}<br><a href=https://yourZincObserveURL.example.com/web/logs?org_identifier={org_name}>Recent logs</a>"
+
+}
+```
+
diff --git a/docs/howto/ingest_ecs_logs_using_firelens.md b/docs/howto/ingest_ecs_logs_using_firelens.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-In order to send logs from [**`tasks`**](## "An `ECS task` is a collection of on or more containers running as a single unit in ECS. If you are from a kubernetes background then an ECS task is equivalent to a pod") running in ECS (on fargate and ec2 for linux) to ZincObserve, AWS firelens is the recommended mechanism. AWS firelens is a log router for Amazon ECS that sends log data from containers running in ECS tasks to fluentbit (or fluentd) sidecar container which can then send data to wherever fluentbit supports sending data.  A sidecar container is simply an additional container running along side the main container in a task that performs some ancillary services - e.g. collecting logs, keep configuration up to date, etc. We recommend that you use fluentbit instead of fluentd due to its much lower resource requirements.
+In order to send logs from [**`tasks`**](## "An `ECS task` is a collection of on or more containers running as a single unit in ECS. If you are from a kubernetes background then an ECS task is equivalent to a pod") running in ECS (on fargate and ec2 for linux) to ZincObserve, AWS firelens is the recommended mechanism. AWS firelens is a log router for Amazon ECS that sends log data from containers running in ECS tasks to fluentbit (or fluentd) sidecar container which can then send data to wherever fluentbit supports sending data. A sidecar container is simply an additional container running along side the main container in a task that performs some ancillary services - e.g. collecting logs, keep configuration up to date, etc. We recommend that you use fluentbit instead of fluentd due to its much lower resource requirements.
 
 If you have existing ECS tasks from which you need to send logs to ZincObserve, then you will need to modify their task definition to add fluentbit sidecar. Let's take a look at how to accomplish this.
 
@@ -15,7 +15,7 @@ We will run our tasks using fargate for this demonstration.
 
 ## Get Zinc Cloud / ZincObserve Configuration
 
-Before you can start with setting up the configuration of your ECS task you will need the details of your ZincObserve where you will send the logs. 
+Before you can start with setting up the configuration of your ECS task you will need the details of your ZincObserve where you will send the logs.
 
 > You can either use a self hosted ZincObserve or [Zinc Cloud](https://observe.zinc.dev) for following this guide. You can get started with [Zinc Cloud](https://observe.zinc.dev) for free at [https://observe.zinc.dev](https://observe.zinc.dev) that has a generous free tier.
 
@@ -36,9 +36,7 @@ Create the following file and save it as "nginx_firelens_zo_task_def.json"
   "executionRoleArn": "arn:aws:iam::058694856476:role/ecsTaskExecutionRole",
   "cpu": "512",
   "memory": "1024",
-  "requiresCompatibilities": [
-    "FARGATE"
-  ],
+  "requiresCompatibilities": ["FARGATE"],
   "networkMode": "awsvpc",
   "containerDefinitions": [
     {
@@ -97,37 +95,29 @@ Create the following file and save it as "nginx_firelens_zo_task_def.json"
 
 `options` section has [http output plugin](https://docs.fluentbit.io/manual/pipeline/outputs/http) configuration for fluentbit. Configure this section with the values you got from ZincObserve.
 
-
 Register the task definition using the below command:
 
 ```shell
 aws ecs register-task-definition --cli-input-json file://nginx_firelens_zo_task_def.json
 ```
 
-
 We will also need to provide network configuration when using networkMode as `awsvpc` during service creation. Let's create a json file for that:
 
 ```json title="Network configuration - network_config.json" linenums="1" hl_lines="10"
 {
   "awsvpcConfiguration": {
-    "subnets": [
-      "subnet-12345678",
-      "subnet-23456789"
-    ],
-    "securityGroups": [
-      "sg-12345678"
-    ],
+    "subnets": ["subnet-12345678", "subnet-23456789"],
+    "securityGroups": ["sg-12345678"],
     "assignPublicIp": "ENABLED"
   }
 }
 ```
 
 **Note**: `Do not` set `assignPublicIp` on line `10` as ENABLED for real world scenarios. You do not want to access tasks directly. We are doing this now only for demonstration. You should always either front the services with a load balancer or AWS `Cloud Map`.
 
-
 ## Create ECS service
 
-Now let's create an ECS `service` that will use this task definition. 
+Now let's create an ECS `service` that will use this task definition.
 
 Assuming the name of your cluster - `ecs1_fargate_cluster1` run below command:
 
@@ -154,19 +144,16 @@ Now click on the task:
 
 ![ Task details](./images/firelens/task_details.png)
 
-
 You should see the `Public IP` for the task.
 
 Click `open address`. You should see the following page:
 
 ![Nginx page](./images/firelens/nginx.png)
 
-
 Now head on the ZincObserve / Zinc Cloud and see the logs flowing in there.
 
-![ECS logs in Zinc Observe](./images/firelens/zo_logs.png)
+![ECS logs in ZincObserve](./images/firelens/zo_logs.png)
 
 ## Conclusion
 
 AWS firelens provides an easy way to send ECS container logs to ZincObserve. We configured AWS firelens in few steps to send logs to ZincObserve / Zinc cloud. to easily view and analyze logs.
-
diff --git a/openapi1/redoc.html b/openapi1/redoc.html
@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"> </script>
+  </head>
+  <body>
+    <redoc spec-url="https://alpha1.gke.zinclabs.dev/api-doc/openapi.json"></redoc>
+  </body>
+</html>
diff --git a/openapi1/spotlightio-elements.html b/openapi1/spotlightio-elements.html
@@ -0,0 +1,53 @@
+<!doctype html>
+<html lang="en">
+
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+  <meta name="description" content="">
+  <meta name="author" content="">
+
+  <title>Elements in Twitter Bootstrap</title>
+
+  <!-- Elements: Web Component -->
+  <script src="https://unpkg.com/@stoplight/elements/web-components.min.js"></script>
+  <link rel="stylesheet" href="https://unpkg.com/@stoplight/elements/styles.min.css">
+
+  <!-- Twitter Bootstrap -->
+  <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css">
+  <!-- Twitter Bootstrap: Sticky Footer Example -->
+  <link rel="stylesheet"
+    href="https://getbootstrap.com/docs/4.5/examples/sticky-footer-navbar/sticky-footer-navbar.css">
+
+  <style>
+    body {
+      display: flex;
+      flex-direction: column;
+      height: 100vh;
+    }
+
+    main {
+      flex: 1 0 0;
+      overflow: hidden;
+    }
+  </style>
+</head>
+
+<body>
+
+  <header>
+  </header>
+
+  <!-- Begin page content -->
+  <main role="main">
+    <elements-api apiDescriptionUrl="https://alpha1.gke.zinclabs.dev/api-doc/openapi.json" router="hash" />
+  </main>
+
+  <footer class="footer">
+    <div class="container">
+      <span class="text-muted">Awesome footer goes here.</span>
+    </div>
+  </footer>
+</body>
+
+</html>
