Add missing quick starts, content info, cleanup, etc. (#75)
* update project status text (fix #56) * add content card for ott, polish on cards (fix #43) * add js qs (fix #33) * add java qs (fix #37) * blur qs items on frontpage as there's no content yet * add gh edit badge
This commit is contained in:
Austin Parker
GitHub
parent
b20e7ad9ad
commit
5023f3c0b2
|
|
@ -6,4 +6,60 @@ This page contains documentation for OpenTelemetry Java.
|
|||
|
||||
# Quick Start
|
||||
|
||||
**Please note** that this library is currently in *alpha*, and shouldn't be used in production environments.
|
||||
|
||||
First, you'll need to import the OpenTelemetry API and/or SDK into your project.
|
||||
|
||||
**Maven**
|
||||
|
||||
```xml
|
||||
<repositories>
|
||||
<repository>
|
||||
<id>oss.sonatype.org-snapshot</id>
|
||||
<url>https://oss.jfrog.org/artifactory/oss-snapshot-local</url>
|
||||
</repository>
|
||||
</repositories>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>io.opentelemetry</groupId>
|
||||
<artifactId>opentelemetry-api</artifactId>
|
||||
<version>0.2.0-SNAPSHOT</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
```
|
||||
|
||||
**Gradle**
|
||||
|
||||
```groovy
|
||||
repositories {
|
||||
maven { url 'https://oss.jfrog.org/artifactory/oss-snapshot-local' }
|
||||
}
|
||||
|
||||
dependencies {
|
||||
compile('io.opentelemetry:opentelemetry-api:0.2.0-SNAPSHOT')
|
||||
}
|
||||
```
|
||||
|
||||
Libraries will usually only need `opentelemetry-api`, while applications
|
||||
may want to use `opentelemetry-sdk`.
|
||||
|
||||
Next, import the necessary classes in your code.
|
||||
|
||||
```java
|
||||
import io.opentelemetry.trace.Tracer;
|
||||
import io.opentelemetry.exporters.inmemory.InMemorySpanExporter;
|
||||
```
|
||||
|
||||
Finally, create a tracer and exporter, then start creating spans.
|
||||
|
||||
```java
|
||||
private final InMemorySpanExporter exporter = InMemorySpanExporter.create();
|
||||
private final Tracer tracer = createTracer("tracer", exporter);
|
||||
|
||||
Span span = tracer.spanBuilder("test").startSpan();
|
||||
// do work
|
||||
span.end();
|
||||
```
|
||||
|
||||
# API Reference
|
||||
|
|
|
|||
|
|
@ -6,5 +6,66 @@ This page contains documentation for OpenTelemetry JS.
|
|||
|
||||
# Quick Start
|
||||
|
||||
**Please note** that this library is currently in *alpha*, and shouldn't be used in production environments.
|
||||
|
||||
To begin, install the appropriate packages via your package manager.
|
||||
|
||||
```bash
|
||||
npm install --save @opentelemetry/core
|
||||
npm install --save @opentelemetry/tracing
|
||||
npm install --save @opentelemetry/exporter-jaeger
|
||||
```
|
||||
|
||||
Next, import the OpenTelemetry packages and Jaeger exporter and initialize them.
|
||||
|
||||
```js
|
||||
const opentelemetry = require('@opentelemetry/core');
|
||||
const { BasicTracer, SimpleSpanProcessor } = require('@opentelemetry/tracing');
|
||||
const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
|
||||
|
||||
const exporter = new JaegerExporter({
|
||||
serviceName: 'myService'
|
||||
});
|
||||
|
||||
const tracer = new BasicTracer();
|
||||
|
||||
tracer.AddSpanProcessor(new SimpleSpanProcessor(exporter))
|
||||
opentelemetry.initGlobalTracer(tracer)
|
||||
```
|
||||
|
||||
Now, you're ready to create spans!
|
||||
|
||||
```js
|
||||
const span = opentelemetry.getTracer().startSpan('main');
|
||||
for (let i = 0; i < 10; i++) {
|
||||
doWork(span);
|
||||
}
|
||||
// Be sure to end the span.
|
||||
span.end();
|
||||
|
||||
// flush and close the connection.
|
||||
exporter.shutdown();
|
||||
|
||||
function doWork(parent) {
|
||||
// Start another span. In this example, the main method already started a
|
||||
// span, so that'll be the parent span, and this will be a child span.
|
||||
const span = opentelemetry.getTracer().startSpan('doWork', {
|
||||
parent: parent
|
||||
});
|
||||
|
||||
// simulate some random work.
|
||||
for (let i = 0; i <= Math.floor(Math.random() * 40000000); i++) { }
|
||||
|
||||
// Set attributes to the span.
|
||||
span.setAttribute('key', 'value');
|
||||
|
||||
// Annotate our span to capture metadata about our operation
|
||||
span.addEvent('invoking doWork').end();
|
||||
}
|
||||
```
|
||||
See [this GitHub repository](https://github.com/open-telemetry/opentelemetry-js/tree/master/examples/basic-tracer-node) for a working code sample in node.js.
|
||||
|
||||
Looking for an example of how to use OpenTelemetry in the browser? [Check out this GitHub repository](https://github.com/open-telemetry/opentelemetry-js/tree/master/examples).
|
||||
|
||||
# API Reference
|
||||
|
||||
|
|
|
|||
|
|
@ -4,43 +4,24 @@ Title: "Project Status"
|
|||
|
||||
OpenTelemetry implementations are currently in **pre-release** status. This page tracks the overall release milestones as we move towards full releases for each language SIG. You can find more details about the milestones at [this link](https://github.com/open-telemetry/opentelemetry-specification/blob/master/milestones.md)
|
||||
|
||||
# Summary
|
||||
Our current goal is to provide a generally available, production quality release by the second half of 2020. Currently, we are in the _alpha_ stage. What follows is a brief explanation of what we expect to be available, when.
|
||||
|
||||
## 0.2
|
||||
This release is expected to include a functional tracing implementation. While the API may change, you should be able to use these releases to begin exploring and understanding the API and the SDK, and the changes that have been made from OpenTracing/OpenCensus. This release also includes support for distributed context using the W3C TraceContext specification.
|
||||
|
||||
## 0.3
|
||||
This release is expected to contain a functional metrics implementation. Again, you may see changes to the API and the SDK after this point, but it's anticipated that these releases will allow you to explore and understand the changes that have been made from OpenCensus. In addition, this release is anticpated to include improvements to OpenTelemetry Context (such as handling baggage), various semantic conventions around trace and metric metadata, and a finalized OpenTelemetry protocol.
|
||||
|
||||
## 0.4
|
||||
This release is expected to contain further improvements to the tracing and metrics API and SDK in response to feedback gathered during the prior alpha releases. Additionally, we expect that the OpenTelemetry protocol will be fully implemented and languages will include an exporter to the OpenTelemetry Collector. At this phase, we anticipate all APIs will be unlikely to change.
|
||||
|
||||
## Beta, RC, and Release
|
||||
We anticipate that once the alpha phase is complete, we'll enter into a period of final stabilization work around the API, SDK, and other components. This includes benchmarking, profiling, interoperability testing suites, and other work to ensure that the final release is performant and of a high quality. This work is anticipated to complete by the second half of 2020.
|
||||
|
||||
# Current SIG Progress
|
||||
{{< progress_chart >}}
|
||||
<sub>Click a progress bar in the above chart to go to that SIGs repository.</sub>
|
||||
|
||||
# Current SIG Release
|
||||
{{< release_notes >}}
|
||||
|
||||
# Status Definitions
|
||||
|
||||
When we refer to an alpha, beta, or release, what do we mean? This section defines these terms.
|
||||
|
||||
## Alpha
|
||||
|
||||
* APIs: Metrics, Tracing, Context.
|
||||
* These APIs do not need to match the latest version of the specification.
|
||||
* A baggage API is not required.
|
||||
* OpenTracing/OpenCensus Shims
|
||||
* 'First pass' of support.
|
||||
* There may be bugs or edge cases that aren't handled.
|
||||
* Exporters
|
||||
* Jaeger exporter for traces.
|
||||
* Prometheus exporter for metrics.
|
||||
* Documentation
|
||||
* API Documentation
|
||||
* A quickstart guide in the README.
|
||||
* A project status section in the README.
|
||||
|
||||
## Beta
|
||||
|
||||
* APIs: Metrics, Tracing, Context.
|
||||
* These APIs match the latest version of the specification.
|
||||
* OpenTracing/OpenCensus Shims
|
||||
* These have been tested and validated against common use cases and popular instrumentation libraries.
|
||||
* Exporters
|
||||
* Jaeger and Prometheus exporters have been tested and profiled.
|
||||
* Other exporters may exist with their own stability/performance guarantees.
|
||||
* Documentation
|
||||
* API, Quick Start, and comprehensive usage examples are available.
|
||||
|
||||
## Release Candidate
|
||||
|
|
|
|||
|
|
@ -8,7 +8,9 @@
|
|||
</title>
|
||||
{{ partial "header.html" . }}
|
||||
</head>
|
||||
{{ partial "ghbadge.html" . }}
|
||||
<body class="page">
|
||||
|
||||
<main class="main">
|
||||
{{ block "main" . }}
|
||||
{{ end }}
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{{ define "main" }}
|
||||
{{ partial "home/hero.html" . }}
|
||||
{{ partial "home/blog.html" . }}
|
||||
{{ partial "home/cards.html" . }}
|
||||
{{ partial "home/quickStart.html" . }}
|
||||
{{ partial "home/cncf.html" . }}
|
||||
{{ end }}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,52 @@
|
|||
{{ $urlTrimmed := strings.TrimRight "/" .RelPermalink }}
|
||||
<a
|
||||
href="https://github.com/open-telemetry/opentelemetry.io/tree/master/content{{ $urlTrimmed }}.md"
|
||||
class="github-corner"
|
||||
aria-label="View source on GitHub"
|
||||
target="blank"
|
||||
><svg
|
||||
width="80"
|
||||
height="80"
|
||||
viewBox="0 0 250 250"
|
||||
style="fill:#151513; color:#fff; position: absolute; top: 55; border: 0; right: 10;"
|
||||
aria-hidden="true"
|
||||
>
|
||||
<path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path>
|
||||
<path
|
||||
d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2"
|
||||
fill="currentColor"
|
||||
style="transform-origin: 130px 106px;"
|
||||
class="octo-arm"
|
||||
></path>
|
||||
<path
|
||||
d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z"
|
||||
fill="currentColor"
|
||||
class="octo-body"
|
||||
></path></svg></a
|
||||
><style>
|
||||
.github-corner:hover .octo-arm {
|
||||
animation: octocat-wave 560ms ease-in-out;
|
||||
}
|
||||
@keyframes octocat-wave {
|
||||
0%,
|
||||
100% {
|
||||
transform: rotate(0);
|
||||
}
|
||||
20%,
|
||||
60% {
|
||||
transform: rotate(-25deg);
|
||||
}
|
||||
40%,
|
||||
80% {
|
||||
transform: rotate(10deg);
|
||||
}
|
||||
}
|
||||
@media (max-width: 500px) {
|
||||
.github-corner:hover .octo-arm {
|
||||
animation: none;
|
||||
}
|
||||
.github-corner .octo-arm {
|
||||
animation: octocat-wave 560ms ease-in-out;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
|
|
@ -1,35 +1,23 @@
|
|||
{{ $blogData := getJSON "https://api.rss2json.com/v1/api.json?rss_url=https%3A%2F%2Fmedium.com%2Ffeed%2Fopentelemetry" }}
|
||||
|
||||
|
||||
<div class="columns is-centered">
|
||||
<div class="column is-one-third">
|
||||
<p class="is-size-4-desktop is-size-5-tablet is-size-6-mobile has-text-weight-bold">
|
||||
The latest from our blog -
|
||||
</p>
|
||||
|
||||
{{ range first 1 $blogData.items }}
|
||||
{{ range first 1 $blogData.items }}
|
||||
<div class="card">
|
||||
{{ if or (in .thumbnail ".png") (in .thumbnail ".jpeg") ( in .thumbnail ".jpg") }}
|
||||
<div class="card-image">
|
||||
<figure class="image">
|
||||
<img src="{{ .thumbnail }}" id="blog-image" />
|
||||
<figure class="image is-fullwidth">
|
||||
<img src="/img/otel-blog-card.jpg" id="blog-image" />
|
||||
</figure>
|
||||
</div>
|
||||
{{ end }}
|
||||
<div class="card-content">
|
||||
<p class="title is-4" id="blog-title">{{ .title }}</p>
|
||||
<p class="subtitle is-6" id="blog-author">{{ .author }}</p>
|
||||
</div>
|
||||
<footer class="card-footer">
|
||||
<p class="card-footer-item">Posted on <span id="blog-date">{{ dateFormat "January 2, 2006" .pubDate }}</span></p>
|
||||
<p class="card-footer-item"><span id="blog-date">{{ dateFormat "January 2, 2006" .pubDate }}</span></p>
|
||||
<p class="card-footer-item">
|
||||
<span>Read more on <a href="{{ .link }}" id="blog-link">Medium</a></span>
|
||||
</p>
|
||||
</footer>
|
||||
</div>
|
||||
{{ end }}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,13 @@
|
|||
<div class="container">
|
||||
<div class="columns is-center">
|
||||
<div class="column is-one-third">
|
||||
{{ partial "home/blog.html" . }}
|
||||
</div>
|
||||
<div class="column is-one-third">
|
||||
{{ partial "home/live.html" . }}
|
||||
</div>
|
||||
<div class="column is-one-third">
|
||||
{{ partial "home/video.html" . }}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
<div class="card">
|
||||
<div class="card-image">
|
||||
<figure class="image">
|
||||
<img src="/img/oteltuessplash_sm.png" />
|
||||
</figure>
|
||||
</div>
|
||||
<div class="card-content">
|
||||
<p class="title is-4">OpenTelemetry Tuesdays</p>
|
||||
<p class="subtitle is-6">Presented by Liz Fong-Jones and Isobel Redelmeier</p>
|
||||
</div>
|
||||
<footer class="card-footer">
|
||||
<p class="card-footer-item">
|
||||
<span>Subscribe to our channel on <a href="https://www.twitch.tv/opentelemetry">twitch.tv/opentelemetry</a></span>
|
||||
</p>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -1,9 +1,28 @@
|
|||
<style>
|
||||
.blur {
|
||||
filter: progid:DXImageTransform.Microsoft.Blur(PixelRadius='3');
|
||||
-webkit-filter: url(#blur-filter);
|
||||
filter: url(#blur-filter);
|
||||
-webkit-filter: blur(3px);
|
||||
filter: blur(3px);
|
||||
}
|
||||
.blur-svg {
|
||||
display: none;
|
||||
}
|
||||
</style>
|
||||
<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" class="blur-svg">
|
||||
<defs>
|
||||
<filter id="blur-filter">
|
||||
<feGaussianBlur stdDeviation="3"></feGaussianBlur>
|
||||
</filter>
|
||||
</defs>
|
||||
</svg>
|
||||
<section class="section has-text-centered has-background-white-bis">
|
||||
<div class="container">
|
||||
<p class="title is-size-3 is-size-4-mobile has-text-weight-bold">
|
||||
Get Started
|
||||
Get Started (Coming Soon!)
|
||||
</p>
|
||||
<div class="columns is-vcentered">
|
||||
<div class="columns is-vcentered blur">
|
||||
<div class="column">
|
||||
<div class="card">
|
||||
<header class="card-header">
|
||||
|
|
|
|||
|
|
@ -0,0 +1,19 @@
|
|||
<div class="card">
|
||||
<div class="card-image">
|
||||
<figure class="image">
|
||||
<img src="/img/otel-yt-card.jpg" />
|
||||
</figure>
|
||||
</div>
|
||||
<div class="card-content">
|
||||
<p class="title is-4">OpenTelemetry on YouTube</p>
|
||||
<p class="subtitle is-6">Find recordings of our SIG meetings, and more.</p>
|
||||
</div>
|
||||
<footer class="card-footer">
|
||||
<p class="card-footer-item">
|
||||
<span>Subscribe to our channel on <a href="https://www.youtube.com/channel/UCHZDBZTIfdy94xMjMKz-_MA">YouTube</a></span>
|
||||
</p>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 9.5 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 9.8 KiB |
Loading…
Reference in New Issue