Skip to content

Commit

Permalink
all: website redesign and restructure (census-instrumentation#193)
Browse files Browse the repository at this point in the history 
Following feedback from lots of hours of interviews
from teams, community, OpenCensus users and
customers, this website redesign is the product.
  • Loading branch information
Emmanuel T Odeke authored Jul 26, 2018
1 parent 22402e3 commit 063fa3a
Show file tree
Hide file tree
Showing 1,988 changed files with 247,647 additions and 46,483 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ Press Ctrl+C to stop

[website]: http://opencensus.io
[install-hugo]: https://gohugo.io/getting-started/installing/
[version-control]: https://github.com/gohugoio/hugo/releases/tag/v0.31.1
[version-control]: https://github.com/gohugoio/hugo/releases/tag/v0.31.1
6 changes: 6 additions & 0 deletions archetypes/default.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "{{ replace .Name "-" " " | title }}"
date: {{ .Date }}
draft: true
---

0 themes/census/README.md → codelabs/README.md
View file
File renamed without changes.
34 changes: 34 additions & 0 deletions codelabs/googlecloudstorage.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
author: Emmanuel Odeke and Henry Ventura
summary: Setup and configure Google Stackdriver
environments: Web
id: googlecloudstorage

# Setup and Configure Google Cloud Storage

## Overview of the tutorial
Duration: 0:01

This tutorial shows you how to setup and configure Google Cloud Storage

Requirements:

* A Google Cloud Platform project

## Create a Project on Google Cloud
Duration: 0:02

If you haven't already created a project on Google Cloud, [you can do so here](https://console.cloud.google.com/projectcreate).

## Enable the Spanner APIs
Duration: 0:03

You will be enabling this API:

* [Cloud Storage API](https://console.cloud.google.com/apis/library?q=storage-component)

![img](https://cdn-images-1.medium.com/max/1500/1*r7KreflK6XIdX8fjAHqoVA.png)

## Enable Application Default Credentials
Duration: 0:01

Please make sure to enable Application Default Credentials for authentication. [Click here](https://developers.google.com/identity/protocols/application-default-credentials) to do so.
20 changes: 20 additions & 0 deletions codelabs/googlecloudstorage/codelab.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"environment": "web",
"source": "google_cloud_storage.md",
"format": "html",
"prefix": "../../",
"mainga": "UA-49880327-14",
"updated": "2018-07-24T23:08:01-07:00",
"id": "googlecloudstorage",
"duration": 4,
"title": "Setup and Configure Google Cloud Storage",
"author": "Emmanuel Odeke and Henry Ventura",
"summary": "Setup and configure Google Stackdriver",
"theme": "",
"status": null,
"category": null,
"tags": [
"web"
],
"url": "googlecloudstorage"
}
Binary file added codelabs/googlecloudstorage/img/a4ab2ad9eb740b8e.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
90 changes: 90 additions & 0 deletions codelabs/googlecloudstorage/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@

<!doctype html>

<html>
<head>
<meta name="viewport" content="width=device-width, minimum-scale=1.0, initial-scale=1.0, user-scalable=yes">
<meta name="theme-color" content="#4F7DC9">
<meta charset="UTF-8">
<title>Setup and Configure Google Cloud Storage</title>
<script src="../../bower_components/webcomponentsjs/webcomponents-lite.js"></script>
<link rel="import" href="../../elements/codelab.html">
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Source+Code+Pro:400|Roboto:400,300,400italic,500,700|Roboto+Mono">
<style is="custom-style">
body {
font-family: "Roboto",sans-serif;
background: var(--google-codelab-background, #F8F9FA);
}
</style>

</head>
<body unresolved class="fullbleed">

<google-codelab title="Setup and Configure Google Cloud Storage"
environment="web"
feedback-link="">

<google-codelab-step label="Overview of the tutorial" duration="1">
<p>This tutorial shows you how to setup and configure Google Cloud Storage</p>
<p>Requirements:</p>
<ul>
<li>A Google Cloud Platform project</li>
</ul>


</google-codelab-step>

<google-codelab-step label="Create a Project on Google Cloud" duration="1">
<p>If you haven&#39;t already created a project on Google Cloud, <a href="https://console.cloud.google.com/projectcreate" target="_blank">you can do so here</a>.</p>


</google-codelab-step>

<google-codelab-step label="Enable the Spanner APIs" duration="1">
<p>You will be enabling this API:</p>
<ul>
<li><a href="https://console.cloud.google.com/apis/library?q=storage-component" target="_blank">Cloud Storage API</a></li>
</ul>
<p><img alt="img" src="img/a4ab2ad9eb740b8e.png"></p>


</google-codelab-step>

<google-codelab-step label="Enable Application Default Credentials" duration="1">
<p>Please make sure to enable Application Default Credentials for authentication. <a href="https://developers.google.com/identity/protocols/application-default-credentials" target="_blank">Click here</a> to do so.</p>


</google-codelab-step>

</google-codelab>

<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-49880327-14', 'auto');

(function() {
var gaCodelab = '';
if (gaCodelab) {
ga('create', gaCodelab, 'auto', {name: 'codelab'});
}

var gaView;
var parts = location.search.substring(1).split('&');
for (var i = 0; i < parts.length; i++) {
var param = parts[i].split('=');
if (param[0] === 'viewga') {
gaView = param[1];
break;
}
}
if (gaView && gaView !== gaCodelab) {
ga('create', gaView, 'auto', {name: 'view'});
}
})();
</script>

</body>
</html>
54 changes: 54 additions & 0 deletions codelabs/jaeger.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
author: Emmanuel Odeke and Henry Ventura
summary: Setup and configure Jaeger
environments: Web
id: jaeger

# Setup and Configure Jaeger

## Overview of the tutorial
Duration: 0:05

This tutorial shows you how to setup and configure Jaeger

![](https://www.jaegertracing.io/img/jaeger-logo.png)

Jaeger, inspired by Dapper and OpenZipkin, is a distributed tracing system released as open source by Uber Technologies. It is used for monitoring and troubleshooting microservices-based distributed systems, including:

Distributed context propagation
Distributed transaction monitoring
Root cause analysis
Service dependency analysis
Performance / latency optimization

Requirements:

* Docker, if you don't already have it, you can learn [How to install Docker](https://docs.docker.com/install/)

## Downloading the Jaeger Docker image
Duration: 0:01

We'll get the Jaeger Docker image from https://hub.docker.com/u/jaegertracing/

by

```
docker pull jaegertracing/all-in-one:latest
```

## Starting Jaeger
Duration: 0.01

```
docker run -d --name jaeger \
-e COLLECTOR_ZIPKIN_HTTP_PORT=9411 \
-p 5775:5775/udp \
-p 6831:6831/udp \
-p 6832:6832/udp \
-p 5778:5778 \
-p 16686:16686 \
-p 14268:14268 \
-p 9411:9411 \
jaegertracing/all-in-one:latest
```

and now the Jaeger user interface can be opened in your web browser by visiting [http://localhost:16686](http://localhost:16686/)
20 changes: 20 additions & 0 deletions codelabs/jaeger/codelab.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"environment": "web",
"source": "jaeger.md",
"format": "html",
"prefix": "../../",
"mainga": "UA-49880327-14",
"updated": "2018-07-21T18:00:01-07:00",
"id": "jaeger",
"duration": 2,
"title": "Setup and Configure Jaeger",
"author": "Emmanuel Odeke and Henry Ventura",
"summary": "Setup and configure Jaeger",
"theme": "",
"status": null,
"category": null,
"tags": [
"web"
],
"url": "jaeger"
}
Binary file added codelabs/jaeger/img/a74b22a1a2749ae7.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
97 changes: 97 additions & 0 deletions codelabs/jaeger/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@

<!doctype html>

<html>
<head>
<meta name="viewport" content="width=device-width, minimum-scale=1.0, initial-scale=1.0, user-scalable=yes">
<meta name="theme-color" content="#4F7DC9">
<meta charset="UTF-8">
<title>Setup and Configure Jaeger</title>
<script src="../../bower_components/webcomponentsjs/webcomponents-lite.js"></script>
<link rel="import" href="../../elements/codelab.html">
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Source+Code+Pro:400|Roboto:400,300,400italic,500,700|Roboto+Mono">
<style is="custom-style">
body {
font-family: "Roboto",sans-serif;
background: var(--google-codelab-background, #F8F9FA);
}
</style>

</head>
<body unresolved class="fullbleed">

<google-codelab title="Setup and Configure Jaeger"
environment="web"
feedback-link="">

<google-codelab-step label="Overview of the tutorial" duration="1">
<p>This tutorial shows you how to setup and configure Jaeger</p>
<p><img src="img/a74b22a1a2749ae7.png"></p>
<p>Jaeger, inspired by Dapper and OpenZipkin, is a distributed tracing system released as open source by Uber Technologies. It is used for monitoring and troubleshooting microservices-based distributed systems, including:</p>
<p>Distributed context propagation<br>Distributed transaction monitoring<br>Root cause analysis<br>Service dependency analysis<br>Performance / latency optimization</p>
<p>Requirements:</p>
<ul>
<li>Docker, if you don&#39;t already have it, you can learn <a href="https://docs.docker.com/install/" target="_blank">How to install Docker</a></li>
</ul>


</google-codelab-step>

<google-codelab-step label="Downloading the Jaeger Docker image" duration="1">
<p>We&#39;ll get the Jaeger Docker image from https://hub.docker.com/u/jaegertracing/</p>
<p>by</p>
<pre><code>docker pull jaegertracing/all-in-one:latest
</code></pre>


</google-codelab-step>

<google-codelab-step label="Starting Jaeger" duration="0">
<pre><code>docker run -d --name jaeger \
-e COLLECTOR_ZIPKIN_HTTP_PORT=9411 \
-p 5775:5775/udp \
-p 6831:6831/udp \
-p 6832:6832/udp \
-p 5778:5778 \
-p 16686:16686 \
-p 14268:14268 \
-p 9411:9411 \
jaegertracing/all-in-one:latest
</code></pre>
<p>and now the Jaeger user interface can be opened in your web browser by visiting <a href="http://localhost:16686/" target="_blank">http://localhost:16686</a></p>


</google-codelab-step>

</google-codelab>

<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-49880327-14', 'auto');

(function() {
var gaCodelab = '';
if (gaCodelab) {
ga('create', gaCodelab, 'auto', {name: 'codelab'});
}

var gaView;
var parts = location.search.substring(1).split('&');
for (var i = 0; i < parts.length; i++) {
var param = parts[i].split('=');
if (param[0] === 'viewga') {
gaView = param[1];
break;
}
}
if (gaView && gaView !== gaCodelab) {
ga('create', gaView, 'auto', {name: 'view'});
}
})();
</script>

</body>
</html>
56 changes: 56 additions & 0 deletions codelabs/prometheus.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
author: Emmanuel Odeke and Henry Ventura
summary: Setup and configure Prometheus
environments: Web
id: prometheus

# Setup and Configure Prometheus

## Overview of the tutorial
Duration: 0:01

This tutorial shows you how to setup and configure Prometheus

![](https://upload.wikimedia.org/wikipedia/en/thumb/3/38/Prometheus_software_logo.svg/115px-Prometheus_software_logo.svg.png)

Prometheus is a monitoring system that collects metrics from systems, by scraping exposed endpoints at
a regular interval. It evaluates rule expressions and displays results. It can also trigger alerts if
alert conditions are met.

Requirements:

* An installation of Prometheus which you can get from here [Install Prometheus](https://prometheus.io/docs/introduction/first_steps/)

## Configure Prometheus
Duration: 0:02

Prometheus Monitoring requires a system configuration usually in the form a ".yaml" file. For example, here is
a sample "prometheus.yaml" file to scrape from our servers running at `localhost:9888`, `localhost:9988` and `localhost:9989`

```
global:
scrape_interval: 10s
external_labels:
monitor: 'media_search'
scrape_configs:
- job_name: 'media_search'
scrape_interval: 10s
static_configs:
- targets: ['localhost:9888', 'localhost:9988', 'localhost:9989']
```

## Starting Prometheus
Duration: 0.05

Having successfully downloaded Prometheus and setup your config.yaml file, you should now be able to run
```shell
prometheus --config.file=prometheus.yaml
```

## Viewing Prometheus output
Duration: 0.01

You should now be able to navigate to [http://localhost:9090/](http://localhost:9090/)
Loading

0 comments on commit 063fa3a

Please sign in to comment.