Skip to content

Commit

Permalink
adds analytics section
Browse files Browse the repository at this point in the history
  • Loading branch information
edublancas committed Apr 5, 2024
1 parent a256d0b commit e177898
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 3 deletions.
7 changes: 4 additions & 3 deletions doc/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ parts:

- caption: User Guide
chapters:
- file: user-guide/cli
- file: user-guide/github
- file: user-guide/secrets
- file: user-guide/password
- file: user-guide/secrets
- file: user-guide/github
- file: user-guide/resources
- file: user-guide/cli
- file: user-guide/analytics
- file: user-guide/gpu
- file: user-guide/custom-domains
- file: user-guide/managing-apps
Expand Down
Binary file added doc/static/analytics/animation.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/static/analytics/button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
59 changes: 59 additions & 0 deletions doc/user-guide/analytics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Analytics

```{important}
Analytics is only available to customers in the Teams plan. While in beta, it'll
also be available to Pro customers.
```

![](../static/analytics/animation.gif)

The real-time analytics report allows you to get detailed information on your
application. Once your application is running, click on the `ANALYTICS REPORT` button
in the app's detailed view:

![](../static/analytics/button.png)

The report updates in real-time; try making some requests to your app to see it!

## Sections

## OVERALL ANALYZED REQUESTS

Offers a summary of your analytics, such as total requests, valid requests,
invalid requests, and unique visitors, among others.

## UNIQUE VISITORS PER DAY

Provides a chart and traffic statistics: hits and unique visitors.

## REQUESTED FILES (URLs)

Allows you to understand application usage by showing statistics on which URLs are
the most used.


## NOT FOUND URLs (404s)

It shows you information on resources that couldn't be located in your application. This
the section can help you find broken links your users are trying to access.

## VISITOR HOSTNAMES AND IPs

Gives you statistics on requests by IPs.

## OPERATING SYSTEMS

Hits and visitors by operating system (macOS, Linux, Windows)

## BROWSERS

Summarizes requests by browser (Firefox, Chrome, etc.)

## REFERRING SITES

Shows which websites are linking to your application.

## HTTP STATUS CODES

Aggregates HTTP status codes by type; you can see successful requests (2xx code),
client errors (4xx code), redirections (3xx), etc.

0 comments on commit e177898

Please sign in to comment.