sematext / docs Goto Github PK

Hi @fbalicchia, can you add the Cassandra plugin docs? If not I can take this task ...

Example config: https://github.com/fbalicchia/logagent-js/blob/master/config/examples/cassandra.yml

We need to add:

• integrations / Monitoring Linux with a list of all OS metrics
• a bit of text and a link to that from various other pages that include OS metrics (I can do this)

What file does http://sematext.com/docs/ open? I'm guessing index.html
What does http://sematext.com/docs/logs/ open? Ooops, nothing. Why? Because there is no index.html

This is just one example of this sort of problem. There may be other such cases under /docs

We should:

• remove /overview from the URL. Instead of opening http://sematext.com/docs/logs/overview/ when one clicks on Log Management > Overview, we should open http://sematext.com/docs/logs/
• keep "Overview" as the name in the navigation on the left side

CC @megastef

Integrations are a top-level thing now. I think that's good. But:

• Integration should really be Integrations
• There are only a few things under Integrations
• The things that are under Integrations have outdated info/screenshots

We need to do something about this.
Here are the sorts of things we could do:

• in index.html add a big grid of integrations similar to http://sematext.com/spm/integrations/ , but not limited to SPM
• a page for each of the integrations. We wouldn't want to duplicate what we have on http://sematext.com/spm/integrations/ so we would want to provide some different/additional info here. For example, people often ask for A) a list of all metrics we monitor, and B) what each metric means. We could provide A) relatively easily. For B) we could enter what we know and encourage people to help us with missing metric descriptions through fork+PR.
• list here not just Monitoring integrations, but also Logs and Notification Hooks

e.g. on http://sematext.com/docs/Logs/ or http://sematext.com/docs/Monitoring/SPM-FAQ/ or ...

Also, look at the alignment - the bullets should be vertically centered, but they seem to be at the bottom of the line.

On http://sematext.com/docs/monitoring/transaction-tracing/

From @prog8 :
can sematext intro video use iframe with "width:100%" so we fill available space?

The docs state different annotation keys for the same functionality.

In installation-docker.md it states:

The Kubernetes pod annotations sematext.com/logs-token=<YOUR_LOGS_TOKEN>, sematext.com/logs-enabled=<true|false>, and sematext.com/logs-receiver-urls=<url,url,url> are equivalent.

while the file output-filter-kubernetes.md says:

Evaluates pod annotations for Sematext Cloud:
sematext/logs-token=YOUR_LOGS_TOKEN to set the log index
sematext/logs-enabled=<true|false> to switch logging per pod on or off
sematext/logs-receiver-url=https://logsene-receiver.sematext.com/token set Elasticsearch API endpoint for log ingestion
sematext/logs-remove-fields=<field list> to remove specific log fields from pod logs

From #general:

I think the landing page would look better with both - the video and the text @denisatudor suggested

I think the centered video on top, followed by the content (without "Welcome to....")

Here's the content:

docs/tracing/enable.md Makes no sense in the context of Node.js tracing

Some questions:

• is there a verbose / debug mode and how is it enabled
• where are Logagent's own logs
• how do I tail multiple files
• how do I ship logs to multiple destinations / Sematext Logs apps
• how do I ship only error logs
• how do I drop logs that match a certain pattern
• how do I ship logs that match different patterns to different destinations / Sematext Logs apps

See < on http://sematext.com/docs/Logs/Search-through-the-Elasticsearch-API/#real-time-get-operation

Maybe other pages have that, too.

We should move https://github.com/sematext/sematext-agent-httpd/blob/master/php-fpm.md and add it to Monitoring PHP - https://sematext.com/docs/integration/php/

We should just not forget to update the Apache and Nginx instructions: https://github.com/search?q=org%3Asematext+To+enable+PHP-FPM+stats+monitoring&type=Code

Looks like we have some 404s in the docs. @goranbajic found them via http://www.brokenlinkcheck.com/

Hi,

The documentation at https://sematext.com/docs/logagent/installation-docker/ appears to come from this repo. The environment var/parameter IGNORE_LOGS_PATTERNS mentioned in the docs does not seem to appear anywhere else (i.e in any other sematext repo).

I suspect this feature was not implemented.

Can you please clarify if the docs were perhaps prematurely updated or maybe there's a typo somewhere?

thanks

• add info to README about how to re-run it, so we can do it from time to time.

It would be good to catch all non-2xx responses, including redirects.

e.g. on http://sematext.com/docs/Monitoring/Chef-Recipe/ we have a link that results in 404.

We provide instructions for each of our Monitoring integrations. Each integration has a public view with those instructions, e.g. https://apps.sematext.com/ui/howto/Apache/overview . We should make it easy for people looking at the docs to see how the integration is done. I did this for Apache - 4b043ec - but we should do it for all other integrations, too. Note that I was able to point to the Apache monitoring agent because it's open-source on Github, and we should do that for other agents that are open-source. Those agents that are not open-source simply won't have that Agent.... info.

http://sematext.com/docs/Logs/Logsene-CLI/

There is no TOC and the title seems wrong.
Also, some titles/headings in the page are bold and some are not.

Examples here: http://sematext.com/docs/Logs/Search-through-the-Elasticsearch-API/#request-body-based-search

Notice that links are still alive but they are marked as deleted.

Under https://sematext.com/docs/integration/ we should have "Monitoring Foo" for every integration we have. On it we should have, among other things, a table of metrics our agents collect. There should be a column with metric names and a column with metric description. Some descriptions we can find online and include in the table. Others we will have to leave blank.

Here is a possibly outdated list of metrics we collect for various integrations:
https://sematext.atlassian.net/wiki/spaces/AF/pages/12189699/Metrics+grouped+by+application+type

We don't need the on-premises part in the URL. We need Overview in the nav bar to point to sematext-enterprise/ and that is it.

There is not much room in the header for the breadcrumb.

Could we please:

• move it down like shown below
• make each part of the breadcrumb clickable

https://github.com/sematext/spm-agent-nodejs/wiki info should be moved to Performance Monitoring > Integrations > Monitoring Node.js

And https://github.com/sematext/spm-agent-nodejs/wiki should be removed.

The info about pm2 should really be added to instructions in SPM.

See http://sematext.com/docs/sematext-enterprise/ for example.

Otis found that search on sematext.com/docs doesn't work well. For example if we search for "reference"
from sematext.com/docs it return 0 results
https://image.prntscr.com/image/DT6vD6s_RdCcvTZ_sh-JkA.png

But when i search locally it results 12 results
https://image.prntscr.com/image/Vt6pl5znRmebd3t2-v_PNA.png

There are something difference between deploy version and dev version.

URLs should have lowercase paths files :

• /Monitoring ==> /monitoring
• /Logs ==> /logs
• /Sematext-Enterprise ==> /sematext-enterprise
• /Logagent ==> /logagent
• ...

Also:

• We can remove that X from X-Special Fields.md

• Logsene-FAQ can just be FAQ, because it's under /Logs . Same with SPM-FAQ.md and Sematext-Apps-FAQ.md

• Alerts---HipChat-Integration.md and other such pages should be changed to just e.g. HipChat-Integration.md and this should be reflected in their URLs, too

• URLs/Pages like http://sematext.com/docs/Monitoring/SPM-for-Docker should be changed to http://sematext.com/docs/Monitoring/Docker (and really http://sematext.com/docs/monitoring/docker after we lowercase URLs/pages)

• URLs/Pages like http://sematext.com/docs/Monitoring/SPM-Monitor---Standalone/ should change to http://sematext.com/docs/Monitoring/SPM-Monitor-Standalone/

• Under https://github.com/sematext/docs/tree/master/docs/Sematext-Enterprise I see On-Premises.md and Sematext-Apps.md . Looks like one of them is extra?

CC @megastef

I see that 404 link in
http://sematext.com/docs/sematext-docker-agent/configuration/

Title above TOC: http://sematext.com/docs/Logs/Logsene-API-Reference/
Title below TOC: http://sematext.com/docs/Monitoring/Custom-Metrics/ (and maybe on other pages)

We want title above TOC.

See http://sematext.com/docs/Monitoring/Alerts---PagerDuty-Integration/ (and maybe other pages, please check)

In SPM FAQ we have sections like Monitoring Solr, Monitoring Elasticsearch..... Monitoring AWS. All of these should be moved under Integrations.

We should move http://sematext.com/docs/monitoring/docker/ to http://sematext.com/docs/sematext-docker-agent