kazusa
/
skywalking-java
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
skywalking-java/docs/en/setup
History
吴晟 Wu Sheng b635e254c4
Provide Meter(metrics) system (#4694) 
Here are the basic and simple usages of the MeterSystem APIs.

## Meter Creation
New meter could be created based on metrics name, function, scope and data type. 
1. Metrics name is still the storage entity name.
2. Functions are every similar with the OAL function, just accepting different input.
```java
final MeterSystem meterSystem = MeterSystem.meterSystem(getManager());
meterSystem.create("test_long_metrics", "avg", ScopeType.SERVICE, Long.class);
```
NOTICE, this creation should only be called in the `module#prepare` stage, otherwise, `Can't create new metrics anymore` exception will be raised after the **CORE** module `start` stage finished. You may find out, there is a chance `create` could be executed successfully in your own `module#start` stage, but it it just because of the sequence of provider loaded by the class loader, **no guarantee, so please don't do that**.

## Runtime Calculation
`AcceptableValue` is the object created at the runtime to accept new metrics value.
```java
         final MeterSystem service = getManager().find(CoreModule.NAME).provider().getService(MeterSystem.class);
        Executors.newSingleThreadScheduledExecutor().scheduleAtFixedRate(new Runnable() {
            @Override
            public void run() {
                final AcceptableValue<Long> value = service.buildMetrics("test_long_metrics", Long.class);
                value.accept(MeterEntity.newService("abc"), 5L);
                value.setTimeBucket(TimeBucket.getMinuteTimeBucket(System.currentTimeMillis()));
                service.doStreamingCalculation(value);
            }
        }, 2, 2, TimeUnit.SECONDS);
```

## Meter Functions
Right now, only `avg` function has been implemented. I submit this PR as soon as possible to get your feedback. I will add more functions.

## Notice
1. Make slow trace query available in the sampled record. Logically, they are the same thing. The UI doesn't need to concern about the trace as a special case.
2. Endpoint dependency will be removed from the dashboard. Because no query available for it. We will provide a new page for that in 8.1
3. Comparison page will be removed due to dashboard is powerful enough to replace it.
 		2020-04-24 23:33:13 +08:00
..
backend Provide Meter(metrics) system (#4694) 2020-04-24 23:33:13 +08:00
envoy fix als docs (#3814) 2019-11-09 12:47:08 +08:00
istio Fix dead link (#4167) 2020-01-03 16:11:02 +08:00
service-agent/java-agent Add Tomcat 9 's Java agent deployment instructions(Linux) (#4645) 2020-04-13 18:12:54 +08:00
README.md Officially add LUA agent link in the main repo and document. (#4402) 2020-02-23 22:27:24 +08:00

README.md

Setup

The document explains how to install Skywalking based on the kind of probes you are going to use. If you don't understand, please read Concepts and Designs first.

Important: Don't forget to configure the timezone on your UI, and you also need to be sure your OAP backend servers are also using the same timezone.

If you have any issues, please check that your issue is not already described in the FAQ.

Download official releases

Language agents in Service

  • Java agent. Introduces how to install java agent to your service, without any impact in your code.

  • LUA agent. Introduce how to install the lua agent in Nginx + LUA module or OpenResty.

The following agents and SDKs are compatible with the SkyWalking's data formats and network protocols, but are maintained by 3rd-parties. You can go to their project repositories for additional info about guides and releases.

Service Mesh

Proxy

Setup backend

Follow backend and UI setup document to understand how the backend and UI configuration works. Different scenarios and advanced features are also explained.

Changes log

Backend, UI and Java agent changes are available here.

Upgrade FAQ

6.x version upgrade FAQ introduces the recommendation ways to do SkyWalking upgrade.