You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by GitBox <gi...@apache.org> on 2021/09/02 09:21:30 UTC
[GitHub] [skywalking] sialais opened a new pull request #7637: More document for meter configurations in backend-meter.md
sialais opened a new pull request #7637:
URL: https://github.com/apache/skywalking/pull/7637
<!--
⚠️ Please make sure to read this template first, pull requests that don't accord with this template
maybe closed without notice.
Texts surrounded by `<` and `>` are meant to be replaced by you, e.g. <framework name>, <issue number>.
Put an `x` in the `[ ]` to mark the item as CHECKED. `[x]`
-->
<!-- ==== 🐛 Remove this line WHEN AND ONLY WHEN you're fixing a bug, follow the checklist 👇 ====
### Fix <bug description or the bug issue number or bug issue link>
- [ ] Add a unit test to verify that the fix works.
- [ ] Explain briefly why the bug exists and how to fix it.
==== 🐛 Remove this line WHEN AND ONLY WHEN you're fixing a bug, follow the checklist 👆 ==== -->
<!-- ==== 📈 Remove this line WHEN AND ONLY WHEN you're improving the performance, follow the checklist 👇 ====
### Improve the performance of <class or module or ...>
- [ ] Add a benchmark for the improvement, refer to [the existing ones](https://github.com/apache/skywalking/blob/master/apm-commons/apm-datacarrier/src/test/java/org/apache/skywalking/apm/commons/datacarrier/LinkedArrayBenchmark.java)
- [ ] The benchmark result.
```text
<Paste the benchmark results here>
```
- [ ] Links/URLs to the theory proof or discussion articles/blogs. <links/URLs here>
==== 📈 Remove this line WHEN AND ONLY WHEN you're improving the performance, follow the checklist 👆 ==== -->
<!-- ==== 🆕 Remove this line WHEN AND ONLY WHEN you're adding a new feature, follow the checklist 👇 ====
### <Feature description>
- [ ] If this is non-trivial feature, paste the links/URLs to the design doc.
- [ ] Update the documentation to include this new feature.
- [ ] Tests(including UT, IT, E2E) are added to verify the new feature.
- [ ] If it's UI related, attach the screenshots below.
==== 🆕 Remove this line WHEN AND ONLY WHEN you're adding a new feature, follow the checklist 👆 ==== -->
Refine backend-meter.md. Adding description on meter configurations.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking] wu-sheng commented on a change in pull request #7637: More document for meter configurations in backend-meter.md
Posted by GitBox <gi...@apache.org>.
wu-sheng commented on a change in pull request #7637:
URL: https://github.com/apache/skywalking/pull/7637#discussion_r700928921
##########
File path: docs/en/setup/backend/backend-meter.md
##########
@@ -42,9 +58,10 @@ expSuffix: <string>
metricPrefix: <string>
# Metrics rule allow you to recompute queries.
metricsRules:
- # The name of rule, which combinates with a prefix 'meter_' as the index/table name in storage.
+ # The name of rule, which combined with a prefix '<metricPrefix>_' as the index/table name in storage.
Review comment:
```suggestion
# The name of rule, which combinates with a prefix '<metricPrefix>_' as the index/table name in storage.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking] sialais commented on a change in pull request #7637: More document for meter configurations in backend-meter.md
Posted by GitBox <gi...@apache.org>.
sialais commented on a change in pull request #7637:
URL: https://github.com/apache/skywalking/pull/7637#discussion_r700936465
##########
File path: docs/en/setup/backend/backend-meter.md
##########
@@ -17,14 +18,29 @@ kafka-fetcher:
bootstrapServers: ${SW_KAFKA_FETCHER_SERVERS:localhost:9092}
```
+## Meter collection
+There are plentiful metrics are collected by default, you may find predefined metrics by oal files located in `config/oal/`.
Review comment:
Yes. but I cannot find anywhere to find all predefined metrics list. just found lots metrics is written in the files. as following, defined in `java-agent.oal`.
```txt
instance_jvm_cpu = from(ServiceInstanceJVMCPU.usePercent).doubleAvg();
instance_jvm_memory_heap = from(ServiceInstanceJVMMemory.used).filter(heapStatus == true).longAvg();
instance_jvm_memory_noheap = from(ServiceInstanceJVMMemory.used).filter(heapStatus == false).longAvg();
```
Is anywhere else can I find all the predefined metrics?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking] wu-sheng commented on a change in pull request #7637: More document for meter configurations in backend-meter.md
Posted by GitBox <gi...@apache.org>.
wu-sheng commented on a change in pull request #7637:
URL: https://github.com/apache/skywalking/pull/7637#discussion_r700930137
##########
File path: docs/en/setup/backend/backend-meter.md
##########
@@ -17,14 +18,29 @@ kafka-fetcher:
bootstrapServers: ${SW_KAFKA_FETCHER_SERVERS:localhost:9092}
```
+## Meter collection
+There are plentiful metrics are collected by default, you may find predefined metrics by oal files located in `config/oal/`.
Review comment:
```suggestion
```
I think we should remove this, due to OAL doesn't relate to MAL at all.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking] wu-sheng commented on a change in pull request #7637: More document for meter configurations in backend-meter.md
Posted by GitBox <gi...@apache.org>.
wu-sheng commented on a change in pull request #7637:
URL: https://github.com/apache/skywalking/pull/7637#discussion_r700938420
##########
File path: docs/en/setup/backend/backend-meter.md
##########
@@ -17,14 +18,29 @@ kafka-fetcher:
bootstrapServers: ${SW_KAFKA_FETCHER_SERVERS:localhost:9092}
```
+## Meter collection
+There are plentiful metrics are collected by default, you may find predefined metrics by oal files located in `config/oal/`.
Review comment:
https://skywalking.apache.org/docs/main/latest/en/guides/backend-oal-scripts/#official-oal-script This is the doc for OAL
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking] wu-sheng commented on pull request #7637: More document for meter configurations in backend-meter.md
Posted by GitBox <gi...@apache.org>.
wu-sheng commented on pull request #7637:
URL: https://github.com/apache/skywalking/pull/7637#issuecomment-911477143
Please update the changes.md in the root folder
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking] sialais commented on pull request #7637: More document for meter configurations in backend-meter.md
Posted by GitBox <gi...@apache.org>.
sialais commented on pull request #7637:
URL: https://github.com/apache/skywalking/pull/7637#issuecomment-911505131
> Please update the changes.md in the root folder
CHANGES.md updated.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking] sialais commented on a change in pull request #7637: More document for meter configurations in backend-meter.md
Posted by GitBox <gi...@apache.org>.
sialais commented on a change in pull request #7637:
URL: https://github.com/apache/skywalking/pull/7637#discussion_r700936465
##########
File path: docs/en/setup/backend/backend-meter.md
##########
@@ -17,14 +18,29 @@ kafka-fetcher:
bootstrapServers: ${SW_KAFKA_FETCHER_SERVERS:localhost:9092}
```
+## Meter collection
+There are plentiful metrics are collected by default, you may find predefined metrics by oal files located in `config/oal/`.
Review comment:
Yes. but I cannot find anywhere to find all predefined metrics list. just found lots metrics is written in the files. as following.
```txt
instance_jvm_cpu = from(ServiceInstanceJVMCPU.usePercent).doubleAvg();
instance_jvm_memory_heap = from(ServiceInstanceJVMMemory.used).filter(heapStatus == true).longAvg();
instance_jvm_memory_noheap = from(ServiceInstanceJVMMemory.used).filter(heapStatus == false).longAvg();
```
Is anywhere else can I find all the predefined metrics?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking] wu-sheng merged pull request #7637: More document for meter configurations in backend-meter.md
Posted by GitBox <gi...@apache.org>.
wu-sheng merged pull request #7637:
URL: https://github.com/apache/skywalking/pull/7637
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking] wu-sheng commented on a change in pull request #7637: More document for meter configurations in backend-meter.md
Posted by GitBox <gi...@apache.org>.
wu-sheng commented on a change in pull request #7637:
URL: https://github.com/apache/skywalking/pull/7637#discussion_r700932626
##########
File path: docs/en/setup/backend/backend-meter.md
##########
@@ -17,14 +18,29 @@ kafka-fetcher:
bootstrapServers: ${SW_KAFKA_FETCHER_SERVERS:localhost:9092}
```
+## Meter collection
+There are plentiful metrics are collected by default, you may find predefined metrics by oal files located in `config/oal/`.
+
+Custom metrics may be collected by Manual Meter API. You may find correct APIs diving into [Server Agents](../service-agent/server-agents.md).
+Custom metrics collected cannot be used directly, they should be configured in `meter-analyzer-config` configuration files, which is described in next part.
+
## Configuration file
The meter receiver is configured via a configuration file. The configuration file defines everything related to receiving
from agents, as well as which rule files to load.
The OAP can load the configuration at bootstrap. If the new configuration is not well-formed, the OAP may fail to start up. The files
are located at `$CLASSPATH/meter-analyzer-config`.
-The file is written in YAML format, defined by the scheme described below. Brackets indicate that a parameter is optional.
+New meter-analyzer-config files is **NOT** enabled by default, you should make meter configuration take effect through section `agent-analyzer` in `application.yml` of skywalking backend.
+```yaml
+ agent-analyzer:
+ selector: ${SW_AGENT_ANALYZER:default}
+ default:
+ # ... take care of other analyzers
+ meterAnalyzerActiveFiles: ${SW_METER_ANALYZER_ACTIVE_FILES:your-custom-meter-conf-without-ext-name} # files could be meter analyzed, files split by ","
Review comment:
```suggestion
meterAnalyzerActiveFiles: ${SW_METER_ANALYZER_ACTIVE_FILES:your-custom-meter-conf-without-ext-name} # The multiple files should be separated by ","
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org