Skip to content

Commit

Permalink
Update docs to remove spring Boot freemium
Browse files Browse the repository at this point in the history
  • Loading branch information
@shavidissa
shavidissa committed Aug 1, 2024
1 parent 7d24a20 commit d4e237f
Show file tree
Hide file tree
Showing 6 changed files with 64 additions and 260 deletions.
2 changes: 1 addition & 1 deletion pages/doc/documentation_getting_started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Our documentation includes reference documentation for API, query language, and
<ul><li><a href="ui_charts_faq.html">Charts FAQ</a> explains how to set color mapping, how to define drilldown links, and more. </li>
<li><a href="wavefront_kubernetes_faq.html">Kubernetes FAQ</a> addresses common questions, such as integrating with third-party applications. </li>
<li><a href="tracing_faq.html">Tracing FAQ</a> helps with common tasks like filtering RED metrics with custom span tags. </li>
<li><a href="wavefront_spring_boot_faq.html">Wavefront and Spring Boot FAQ</a> explains differences between Freemium and trial clusters, how to visualize metrics and traces, and more. </li>
<li><a href="wavefront_spring_boot_faq.html">Wavefront and Spring Boot FAQ</a> explains how to send data to our service from a Spring Boot application and how to visualize metrics and traces, and more. </li>
</ul></td>
<td><img src="/images/wavefront_charts_faq.png" alt="screenshot of TOC of chart FAQ"></td>
</tr>
Expand Down
48 changes: 15 additions & 33 deletions pages/doc/wavefront_spring_boot.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,10 @@ If you use Wavefront for Spring Boot:

## Sending Data from Spring Boot Into Our Service

You can send data from your Spring Boot applications into our service using the Wavefront for Spring Boot Starter (all users) or the Wavefront Spring Boot integration (customers).
You can send data from your Spring Boot applications into our service using the Wavefront for Spring Boot Starter or the Wavefront Spring Boot integration.

* **Wavefront for Spring Boot Starter**<br/> If you configure your application with the Wavefront for Spring Boot starter, you can send metrics, histograms, and traces/spans to our service. Once the data is in our service, you can view your data, find hotspots, and gather more data.

All users can run the Spring Boot Starter with the default settings to view their data in the freemium instance. Certain limitations apply, for example, alerts are not available, but you don't have to sign up.

* **Wavefront for Spring Boot Starter**
<br/> If you configure your application with the Wavefront for Spring Boot starter, you can send metrics, histograms, and traces/spans to our service. Once the data is in our service, you can view your data, find hotspots, and gather more data. Customers can modify the default Wavefront Spring Boot Starter to send data to their cluster.
* **Wavefront Spring Boot Integration**: Customers can access the Wavefront Spring Boot integration directly from their clusters.

## Dashboards
Expand Down Expand Up @@ -58,8 +56,8 @@ This is the default dashboard you see when you run the Spring Boot initializer.
Getting started is easy. Here are some things to know before you start:

* **Ingestion Method**: Wavefront for Spring Boot sends data to our service via [direct ingestion](direct_ingestion.html) by default. You can [configure your application to send data via the Wavefront proxy](#proxy).
* **Target**: Wavefront for Spring Boot sends data to the freemium instance by default. You can [configure your application to send data to your Operations for Applications instance](#step-2-optional-specify-your-operations-for-applications-instance).
* **Account**: By default, the starter sends you to the Freemium instance, auto-negotiates an account, and saves the API token in the `~/.wavefront_freemium` file in your home directory. If you customize the starter to go to your Operations for Applications instance (see Step 2 below) you need to include an API token for that instance.
* **Target**: You can [configure your application to send data to your Operations for Applications instance](#step-2-optional-specify-your-operations-for-applications-instance).
* **Account**: To send data to your Operations for Applications instance (see Step 2 below) you need to include an API token for that instance.

### Prerequisites for Wavefront Spring Boot Starter

Expand Down Expand Up @@ -308,9 +306,9 @@ dependencies {
</div>
</div>

### Step 2 (Optional): Specify Your Operations for Applications Instance
### Step 2: Specify Your Operations for Applications Instance

By default, the Wavefront Spring Boot Starter creates an account for you and sends data to the Freemium instance. If you already have an Operations for Applications account, you can send data there instead by specifying the `uri` and `api-token` properties, as follows:
To send data to your Operations for Applications account, specify the `uri` and `api-token` properties as follows:

```
management.metrics.export.wavefront.api-token=$API_Token
Expand All @@ -326,7 +324,6 @@ management.metrics.export.wavefront.uri=$wavefront_instance
To view your data, you first run your project from the command line, and then click the link that directs you to our service. Follow these steps:

1. Run your project.
{% include note.html content="If you're using the Freemium instance, an account is auto-negotiated or restored from `~/.wavefront_freemium` in your home directory each time the application starts. Otherwise, you're directed to the instance you specified. "%}
<ul id="profileTabs" class="nav nav-tabs">
<li class="active"><a href="#mavenrun" data-toggle="tab">Maven</a></li>
<li><a href="#gradlerun" data-toggle="tab">Gradle</a></li>
Expand All @@ -344,29 +341,19 @@ To view your data, you first run your project from the command line, and then cl
</pre>
</div>
</div>
You see the following printed on your console:
<br/>The following example shows what you see if you're using the Freemium instance:
```
To share this account, make sure the following is added to your configuration:

management.metrics.export.wavefront.api-token=44444-34this-45is-123a-sampletoken
management.metrics.export.wavefront.uri=https://wavefront.surf

Connect to your Wavefront dashboard using this one-time use link:
https://wavefront.surf/us/example
```

1. Add data to your application before you start to view the data in our service.
{% include tip.html content="Try out the [Wavefront for Spring Boot Tutorial](wavefront_springboot_tutorial.html)."%}
1. Click the link (for example, `https://wavefront.surf/us/<name>`) and you are taken to the Wavefront Spring Boot Inventory dashboard where you can examine the data sent by your application.
1. Go to your server instance, click **Dashboards** > **All Dashboards** and enter `Spring Boot Inventory`.
1. Select **Contains: Spring Boot Inventory**, and click the **Spring Boot Inventory** result in the table.
<br/>You are taken to the Wavefront Spring Boot Inventory dashboard where you can examine the data sent by your application.
<br/>Example:
![Spring Boot metrics dashboard](images/springboot_metrics.png)
If your application uses trace data, click the link in the Tracing section of the dashboard to be directed to the Traces Browser.
<br/>Example:
![Spring Boot traces browser](images/springboot_span_logs_pet_clinic.png)
{% include note.html content="Want to see the cool information you can gather from the Traces Browser? See [Explore the Traces Browser](tracing_traces_browser.html)." %}
<!---
<iframe width="768" height="432" src="https://www.youtube.com/embed/K-cviV9mKKA" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
--->



### Custom Configurations
Expand All @@ -377,7 +364,7 @@ Add the following custom configurations to the `application.properties` file.

You can invite users and let them send data to the same cluster:

1. Click the link that was printed on your console and navigate to the Wavefront for Spring Boot Service Dashboard:
1. Go to your server instance and navigate to the Wavefront for Spring Boot Service Dashboard:
{% include note.html content="Save the link that you used to access the Service Dashboard." %}
1. Click the gear icon and select **Accounts**.
1. Click **Invite New Users** and specify a comma-separated list of email addresses.<br/>
Expand All @@ -386,13 +373,8 @@ You can invite users and let them send data to the same cluster:
1. Information about the token and URL are displayed on your terminal. Add them to your project’s `application.properties` file.
```
management.metrics.export.wavefront.api-token=<Enter_Token>
management.metrics.export.wavefront.uri=https://wavefront.surf
management.metrics.export.wavefront.uri=<Enter_Wavefront_Instance>
```
1. If you are using the freemium account and want the single-use login URL to show on the terminal each time you start the application, add `wavefront.freemium-account` to the `application.properties` file and set it to `true`.
```
wavefront.freemium-account=true
```
{% include tip.html content="If you don’t want Operations for Applications to auto-negotiate a freemium account for you, set the value to `false`."%}
1. Restart your application.
<a name="proxy"></a>
Expand Down Expand Up @@ -458,4 +440,4 @@ If you already have an Operations for Applications account, you can start the se
* [Try out the Wavefront for Spring Boot Tutorial](wavefront_springboot_tutorial.html) and see how you can send your data to Wavefront in a few simple steps!
* See the [Wavefront for Spring Boot FAQs](wavefront_spring_boot_faq.html).
<!---Check out [this video](https://youtu.be/Jxwf-Iw-3T8) that shows you how to send data to Wavefront from your Spring Boot application and analyze the data.--->
Loading

0 comments on commit d4e237f

Please sign in to comment.