signoz / signoz.io

SigNoz website | SigNoz is an Open source Application Performance Monitoring (APM) tool 🔥 | An open-source alternative to DataDog, NewRelic, etc. 🖥.

This is source for signoz.io website and docs at signoz.io/docs built on docusaurus 2

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

signoz.io's Issues

Allow users to rate SigNoz docs

Clickhouse allows users to rate doc pages which helps them to get user feedback.
https://clickhouse.com/docs/en/

Update Ruby on Rails docs section

We have recently published blog on how to instrument Ruby on Rails app using opentelementry.
Using that as source we have to update our Ruby on Rails docs.

Test golang sample instrumentation docs

Improve docs of Trace Details page and Metrics page

With help icon feature shipped in v0.5.4, more people will see Trace Details page docs. As of now it doesn't have any details and is just a barebone screenshots page.

https://signoz.io/docs/userguide/trace-details/

Incorrect user message when empty email is provided on Signup to receive updates

Screen.Recording.2022-04-20.at.12.31.31.mov

Support search on the blog and docs on the website

How to add search: https://docusaurus.io/docs/search

Update Technical Architecture doc to add Alert Manager

Not clear what is `historical` and `middle manager` in deep storage config page

First para in deep storage retention page is not clear. User was not sure what is meant by historical and middle manager

The collapse section is behaving erratically

Steps to replicate -

Scroll down to the 'Frequently Asked Questions' section -

Click on one of the expand buttons
Click again to collapse, it doesn't work.

PFA screenshot -

Provide instructions for troubleshooting, upgrade, installs etc. for each supported platforms

Would be good to have the following items around troubleshooting, upgrade etc. for each platform explicitly in our docs so that users can follow them easily

--
Operate

• Docker Standalone

  • Troubleshooting
  • Configure (any configuration tasks)
  • Stop/Start
  • Upgrade
  • Uninstall

• Docker Swarm

  • Troubleshooting
  • Configure (any configuration tasks)
  • Stop/Start
  • Scale up and down
  • Upgrade
  • Uninstall

• Kubernetes

  • Troubleshooting
  • Configure (any configuration tasks)
  • Stop/Start
  • Scale up and down
  • Upgrade
  • Uninstall

Add docs on how to monitor metrics for hosts in which SigNoz is not running

Shift SigNoz.io to NextJS + Docusaurus

https://github.com/SigNoz/engineering-pod/issues/329

Add better contributing docs like this

https://www.chatwoot.com/docs/contributing-guide

Placeholders should be clearly defined

User was confused how to get <service_name>. He mentioned if it is something that needs to be set up in the SigNoz dashboard. It should be clearly called out before the step. And an example should be added after the command.

Update architecture diagram with SigNoz components grouped together and SigNoz mentioned

User was confused as to where does SigNoz comes into the picture. He thought maybe SigNoz comes on top of ClickHouse seeing our architectural diagram.

Update link for OpenTelemetry python instrumentation library in docs

Bug description

Please describe.
Link for OpenTelemetry python instrumentation library is not working on this page: https://signoz.io/docs/instrumentation/python

Thank you for your bug report – we love squashing them!

Allow edit doc option for users

Clickhouse allows users to edit official documentation by just clicking the edit button and then create a PR.
Eg: https://clickhouse.com/docs/en/

This would promote user doc contribution and improve our docs.

Is there a way to verify if the app can send data to SigNoz without generating load

User could not generate load on his app due to an internal application issue. Question is how to inform user that everything is fine from SigNoz and that it can now start taking in data.

Update FAQs to answer more specific user queries

https://signoz-community.slack.com/archives/C01LWQ8KS7M/p1645483794708589?thread_ts=1645460777.136749&cid=C01LWQ8KS7M

Add otelgorm docs to golang instrumentation docs

https://github.com/uptrace/opentelemetry-go-extra/tree/main/otelgorm

Docs Update: feat: signoz gh-bot integration

Please document the changes made by this pr 👉 SigNoz/signoz#1151

---

Add SigNoz Custom GH bot as part of PR created and PR merge checks

Opens an issue on adding the update docs on SigNoz.io label on PRs, once they gets merged.

https://github.com/SigNoz/gh-bot/blob/main/create-issue.js

Good Day 🤖

make repo public

Ideal machine/memory size should be specified in the docs for running docker and helm installations

Docs: What to put in `IP of SigNoz backend` not clear to users

User had his app running in Docker and installed SigNoz on localhost. He wanted to know what could be IP of SigNoz backend. Suggested we update our docs with an example. Also suggested to have IP of SigNoz backend in the installation success message that comes on the terminal.

e.g.
https://signoz.io/docs/instrumentation/python/

Add instructions on how to monitor JVM metrics in SigNoz

SigNoz does support JVM metrics as part of Metrics dashboard but this is not explicitly explained in the docs. We should add it in the UserGuid section of the docs as well

Instructions on how to enable this can be found here - https://signoz.notion.site/Adding-JVM-metrics-from-Springboot-40c3b026573f435b932f3a42f8983e13

Add ARM section for docker operate

In docker operate section many commands are not ARM specific: https://signoz.io/docs/operate/docker-standalone/
Have to add a ARM section like below for each command:

Add in docs that applications running in windows are not supported yet

We have not tested the instructions for apps running on windows. Users need to verify on their own if the instructions in docs works

Update Go instrumentations docs with latest instructions

Write blog of sample app for gunicorn

Create tutorial for sample gunicorn sample app
https://signoz.io/docs/instrumentation/python/#running-applications-with-gunicorn-uwsgi

Update in docs instructions on adding alerts for RPS for a service

Rules for checking for all services

        alert: Service Down
        expr: sum(rate(signoz_latency_count{span_kind="SPAN_KIND_SERVER"}[2m])) by (service_name) == 0
        for: 0m
        labels:
            severity: severe
        annotations:
            summary: Service is down
            description: RPS has gone down to 0
			 VALUE = {{ $value }}
			 LABELS = {{ $labels }}"

replace expr with

sum(rate(signoz_latency_count{span_kind="SPAN_KIND_SERVER", service_name='xyz'}[2m])) == 0
for checking a specific service

Parent Issue - Docs structure improvement

• #120
• #119
• #122

Inspiration Posthog and Clickhouse docs

Add sections for manual instrumentation in each language of instrumentation docs

Many users also want to send manual traces to SigNoz. This should be more clearly explained in the docs for each supported language and frameworks

S3 configuration missing in deep storage config page

Are there configurations for s3 storage? If so we should mention it on deep storage configuration.

Image zoom with caption & other functionalities and mobile-fix

For the blog section, we need image zoom functionality with the following functionalities:

• Add caption (see example: medium blog)
• add alt text
• adjust height and width

In the medium blog, the caption does not zoom out with the image. When an image is clicked, only the image zooms out. Our blog should have similar behavior.

Mobile Fix

Currently, on mobile, the images gets smaller on clicking. For reference on how it should work, you can check the same medium blog.

Adding carousel instead of changing it manually

Explain each of you K8S infra metrics in k8s infra metrics tutorial

Explain each of you K8S infra metrics in this section - a small description of what they stand for -> https://signoz.io/docs/tutorial/kubernetes-infra-

Add Typescript Swizzled components

Point signoz.io/slack to redirect to signoz slack community link

Docs: Add instructions in docs on how to remove sample apps

Enable ability to manually configure which blog items are shown in blog list page and in the left side panel

Currently the blog list page shows blogs based on recency. We should have flexibility to also configure this list based on what we want to highlight.

The left side panel in any blog automatically shows recent articles. We should also have ability to manually configure it to show blogs related to the current blog

Upgrade docusaurus to 2.0.0-beta.18

Update port number in Sample Flask app doc

Article: https://signoz.io/blog/opentelemetry-flask/
PR on sample-flask-app repo: SigNoz/sample-flask-app#3

Use versions in docs based on release version

Update Django section of Python instrumentation Docs

Update https://signoz.io/docs/instrumentation/python/#instrumenting-django-applications to link https://signoz.io/blog/opentelemetry-django/

Show list of contributors in each page of docs

Add scroll to top text at the footer

Is your feature request related to a problem?

If I need to access the navbar I need to scroll to the top, any its sometimes very frustrating to scroll again and again to the top of the page which very long(such as the blog page.

Describe the solution you'd like

Add a scroll to top text at the footer of the page so that it is convenient for the user to easily scroll to the top instead of scrolling again and again every time.

Describe alternatives you've considered

Making the navbar fixed and making the blurred navbar once user scroll down to the page.

Additional context

Here is a Figma prototype where the scroll top text is present below the Subscribe section.

Thank you for your feature request – we love each and every one!

Make it clearer in docs instructions on how to restart SigNoz

For testing, it might not be clear to users how to restart/reinstall SigNoz.
Scenario:
A user has installed SigNoz on local host, but he might want to play with it later. In the meantime, he doesn't want SigNoz to keep using the ports.
This guy uninstalled SigNoz bring docker images down using sudo docker-compose -f docker/clickhouse-setup/docker-compose.yaml down -v. But he was unsure whether to use install script again. His question was whether he needs to do this everytime.

Add Test case for website

Is your feature request related to a problem?

Add Test case to find out if there are any bugs in the site. As it improves your application architecture and maintainability.

Describe the solution you'd like

Add various testing case to test several components of the site.

Describe alternatives you've considered

Additional context

Add any other context or screenshots about the feature request here.

Thank you for your feature request – we love each and every one!

Improve deployment process for website

potentially directly deploy with netlify or vercel

Docs: Dashboard feature to plot metrics doesn't have documentation in docs

Expected behavior - docs should have instructions on how to create visualise metrics sent to SigNoz