Openstatus www.openstatus.dev

✍️ add more docs (#859)

authored by

Thibault Le Ouay and committed by
GitHub
39b00b09 422757c7

+35 -34
-30
Docker/clickhouse/docker-compose.yaml
··· 1 - version: "3" 2 - 3 - services: 4 - ch: 5 - image: clickhouse/clickhouse-server:22.8.21.38-alpine 6 - ports: 7 - # enable whichever ports you need. prob just 9000 for starters 8 - # tcp 9 - - 127.0.0.1:9000:9000 10 - # http 11 - - 127.0.0.1:8123:8123 12 - # postgresql 13 - - 127.0.0.1:9005:9005 14 - volumes: 15 - # optional to persist data locally 16 - - ./data:/var/lib/clickhouse/ 17 - # optional to add own config 18 - - ./extra-config.xml:/etc/clickhouse-server/config.d/extra-config.xml 19 - # optional to add users or enable settings for a default user 20 - # - ./user.xml:/etc/clickhouse-server/users.d/user.xml 21 - # qol to mount own sql scripts to run them from inside container with 22 - # clickhouse client < /sql/myquery.sql 23 - - ../../packages/db/clickhouse:/docker-entrypoint-initdb.d 24 - # adjust mem_limit and cpus to machine 25 - mem_limit: 2G 26 - cpus: 1 27 - ulimits: 28 - nofile: 29 - soft: 262144 30 - hard: 262144
apps/docs/images/monitor/public-monitor.png

This is a binary file and will not be displayed.

apps/docs/images/monitor/setting-public-monitor.png

This is a binary file and will not be displayed.

+1 -1
apps/docs/mint.json
··· 160 160 ] 161 161 }, 162 162 { 163 - "group": "Page", 163 + "group": "Status Page", 164 164 "pages": [ 165 165 "api-reference/page/get-page", 166 166 "api-reference/page/get-page-id",
+27
apps/docs/synthetic/features/monitor.mdx
··· 93 93 - **Status Code** 94 94 - **Response Body** 95 95 96 + 97 + ## Public Monitor 🌐 98 + 99 + You can make your monitor public by checking **Allow public monitor**. 100 + 101 + <Frame caption="Public monitor setting"> 102 + <img 103 + src="/images/monitor/setting-public-monitor.png" 104 + alt="Public monitor setting" 105 + /> 106 + </Frame> 107 + 108 + 109 + 110 + A public monitor is accessible by anyone with the monitor URL. 111 + e.g. https://status.openstatus.dev/monitors/1 112 + 113 + 114 + <Frame caption="Public monitor"> 115 + <img 116 + src="/images/monitor/public-monitor.png" 117 + alt="Public monitor" 118 + /> 119 + </Frame> 120 + 121 + If the monitor is attached to a **status page**, the monitor will be displayed on the status page in the **Monitors** tab. 122 + 96 123 ## Video Tutorial 📺 97 124 98 125 <iframe width="560" height="315" src="https://www.youtube.com/embed/nYti3DjHoWY?si=RBGFHzoHFmwphRft" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
+6 -2
apps/docs/synthetic/features/status-page.mdx
··· 41 41 42 42 You can also customize the size of the badge by adding a `size` parameter: 43 43 44 - - `sm 44 + - `sm` 45 45 - `md` 46 46 - `lg` 47 47 - `xl` ··· 49 49 50 50 ```html 51 51 <img src="https://YOUR-SLUG.openstatus.dev/badge?theme=dark&size=xl" /> 52 - ``` 52 + ``` 53 + 54 + ## Add monitors metrics 📊 55 + 56 + If you make your <a href="/synthetic/features/monitor#public-monitor">monitor public</a>, you can display the metrics on your status page.
+1 -1
apps/docs/synthetic/overview.mdx
··· 11 11 12 12 We will alert you if your website or API is down, slow or does not return the expected response. 13 13 14 - You can create monitors in our dashboard, with the API or with Terraform. 14 + You can create monitors in our dashboard, with the <a href="/api-reference/monitor/post-monitor">API</a> or with <a href="/packages/terraform">Terraform</a>. 15 15 16 16 ## Locations 🌍 17 17