Adds a monitoring dashboard to Gradio apps that can be used to view usage #8478

aliabid94 · 2024-06-06T13:28:10Z

This PR adds an analytics dashboard to show all requests processed by the queue and their status. To visit this dashboard, go to the /analytics endpoint. This print a secret URL to the console that you can visit to see the actual analytics dashboard.

gradio-pr-bot · 2024-06-06T13:29:18Z

🪼 branch checks and previews

•	Name	Status	URL
	Spaces	ready!	Spaces preview
	Website	ready!	Website preview
🦄	Changes	detected!	Details

Install Gradio from this PR

pip install https://gradio-builds.s3.amazonaws.com/c03269a6da2cb3e12a7716dcab2115655463867e/gradio-4.33.0-py3-none-any.whl

Install Gradio Python Client from this PR

pip install "gradio-client @ git+https://github.com/gradio-app/gradio@c03269a6da2cb3e12a7716dcab2115655463867e#subdirectory=client/python"

Install Gradio JS Client from this PR

npm install https://gradio-builds.s3.amazonaws.com/c03269a6da2cb3e12a7716dcab2115655463867e/gradio-client-1.1.0.tgz

gradio-pr-bot · 2024-06-06T13:29:27Z

🦄 change detected

This Pull Request includes changes to the following packages.

Package	Version
`gradio`	`minor`

Maintainers can select this checkbox to manually select packages to update.

With the following changelog entry.

Adds a monitoring dashboard to Gradio apps that can be used to view usage

Maintainers or the PR author can modify the PR title to modify this entry.

Something isn't right?

Maintainers can change the version label to modify the version bump.
If the bot has failed to detect any changes, or if this pull request needs to update multiple packages to different versions or requires a more comprehensive changelog entry, maintainers can update the changelog file directly.

abidlabs · 2024-06-06T13:35:25Z

gradio/analytics_dashboard.py

+if __name__ == "__main__":
+    data["data"] = {
+        random.randint(0, 1000000): {
+            "time": time.time() - random.randint(0, 60 * 60 * 24 * 3),
+            "status": random.choice(
+                ["success", "success", "failure", "pending", "queued"]
+            ),
+            "function": random.choice(["predict", "chat", "chat"]),
+            "process_time": random.randint(0, 10),
+        }
+        for r in range(random.randint(100, 200))
+    }
+


Is this real data or mock data?

its mock data that's created if you run this file directly, but will use real data in gradio runtime

…radio into analytics_dashbaord

abidlabs · 2024-06-06T13:38:15Z

2 high-level points @aliabid94:

Instead of going to /analytics which prints a secret token, I think it would make more sense to have a parameter in launch() called enable_monitoring which if set to True, prints the url to the dashboard on launch.
I would use a different word than analytics (maybe monitoring) because analytics_enabled refers to whether we are collecting telemetry or not and I think that would be confusing to users

aliabid94 · 2024-06-06T13:41:55Z

Instead of going to /analytics which prints a secret token, I think it would make more sense to have a parameter in launch() called enable_monitoring which if set to True, prints the url to the dashboard on launch.

Disagree, because if your app prints a lot to console, you will lose the URL deep into console history. Also people will forget to enable it before launching an app, and then lose access to analytics.

abidlabs · 2024-06-06T13:45:23Z

Ok I see what you mean. I still think we should another word than "analytics" like "monitoring"

aliabid94 · 2024-06-06T13:54:15Z

changed to "monitoring"

abidlabs · 2024-06-06T14:35:22Z

gradio/routes.py

+        @app.get("/monitoring/{key}")
+        async def analytics_dashboard(key: str):
+            if key == app.analytics_key:
+                analytics_url = f"/monitoring/{app.analytics_key}/dashboard"
+                if not app.analytics_enabled:
+                    from gradio.analytics_dashboard import data
+                    from gradio.analytics_dashboard import demo as dashboard
+
+                    mount_gradio_app(app, dashboard, path=analytics_url)
+                    dashboard._queue.start()
+                    analytics = app.get_blocks()._queue.event_analytics
+                    data["data"] = analytics
+                    app.analytics_enabled = True
+                return RedirectResponse(
+                    url=analytics_url, status_code=status.HTTP_302_FOUND


If I understand correctly, this will start monitoring only after the first time a user visits this endpoint? Is that intentional - why do we want to do that?

fwiw this essentially allows anyone to "start the monitoring" on anyone else's Gradio app

Anyways, if we do do this, how about we also offer the ability for users to set a parameter in launch() and if they set the parameter, the monitoring URL is immediately printed. I find that pattern more intuitive (and less cumbersome since you have the link immediately available).

Its also easier to describe and publicize -- get an API dashboard with just a single parameter!

I.e.

A user can set enable_monitoring=True when the launch the app

If they forget, they can visible /enable-monitoring or something to start (I'm not sure if we need this at all btw)

Nope, only starts the dashboard app when visiting the secret monitoring link, can add enable_monitoring=True

If I understand correctly, this will start monitoring only after the first time a user visits this endpoint? Is that intentional - why do we want to do that?

Nvm I misunderstood, this is fine

Maybe the parameter is still useful as a way to display the URL right there at launch but not a big deal either way

abidlabs · 2024-06-06T14:39:36Z

Nit: got this printed in the console:

/Users/abidlabs/dev/gradio-repos/gradio/gradio/analytics_dashboard.py:63: FutureWarning: 'T' is deprecated and will be removed in a future version, please use 'min' instead.

abidlabs

Very cool @aliabid94! This looks great & tested works well. There's lots more we can add, but we can ship this as a v1

…radio into analytics_dashbaord

Ali Abid added 2 commits June 6, 2024 06:26

changes

fce24e0

Merge remote-tracking branch 'origin' into analytics_dashbaord

714f4d4

add changeset

2557df9

abidlabs reviewed Jun 6, 2024

View reviewed changes

Ali Abid added 2 commits June 6, 2024 06:36

changes

7227985

Merge branch 'analytics_dashbaord' of https://github.com/gradio-app/g…

646899f

…radio into analytics_dashbaord

changes

3e59ea8

changes

32f6489

Ali Abid and others added 2 commits June 6, 2024 06:54

Merge remote-tracking branch 'origin' into analytics_dashbaord

bdf5080

Merge branch 'main' into analytics_dashbaord

cf5e7da

abidlabs changed the title ~~Analytics dashboard~~ Adds a monitoring dashboard to Gradio apps that can be used to view usage Jun 6, 2024

add changeset

46dc7c0

abidlabs reviewed Jun 6, 2024

View reviewed changes

abidlabs approved these changes Jun 6, 2024

View reviewed changes

Ali Abid and others added 4 commits June 6, 2024 08:01

changes

8f7c1ea

Merge branch 'analytics_dashbaord' of https://github.com/gradio-app/g…

6bd5dae

…radio into analytics_dashbaord

Merge branch 'main' into analytics_dashbaord

186c644

Merge branch 'main' into analytics_dashbaord

c03269a

aliabid94 merged commit 73e1108 into main Jun 6, 2024
7 checks passed

aliabid94 deleted the analytics_dashbaord branch June 6, 2024 15:31

pngwn mentioned this pull request Jun 6, 2024

chore: update versions #8486

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds a monitoring dashboard to Gradio apps that can be used to view usage #8478

Adds a monitoring dashboard to Gradio apps that can be used to view usage #8478

aliabid94 commented Jun 6, 2024

gradio-pr-bot commented Jun 6, 2024 •

edited

Loading

gradio-pr-bot commented Jun 6, 2024 •

edited

Loading

Something isn't right?

abidlabs Jun 6, 2024

aliabid94 Jun 6, 2024

abidlabs Jun 6, 2024

abidlabs commented Jun 6, 2024

aliabid94 commented Jun 6, 2024

abidlabs commented Jun 6, 2024

aliabid94 commented Jun 6, 2024

abidlabs Jun 6, 2024 •

edited

Loading

abidlabs Jun 6, 2024

abidlabs Jun 6, 2024

aliabid94 Jun 6, 2024

abidlabs Jun 6, 2024

abidlabs Jun 6, 2024

abidlabs commented Jun 6, 2024

abidlabs left a comment

Adds a monitoring dashboard to Gradio apps that can be used to view usage #8478

Adds a monitoring dashboard to Gradio apps that can be used to view usage #8478

Conversation

aliabid94 commented Jun 6, 2024

gradio-pr-bot commented Jun 6, 2024 • edited Loading

🪼 branch checks and previews

gradio-pr-bot commented Jun 6, 2024 • edited Loading

🦄 change detected

This Pull Request includes changes to the following packages.

With the following changelog entry.

Something isn't right?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abidlabs commented Jun 6, 2024

aliabid94 commented Jun 6, 2024

abidlabs commented Jun 6, 2024

aliabid94 commented Jun 6, 2024

abidlabs Jun 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abidlabs commented Jun 6, 2024

abidlabs left a comment

Choose a reason for hiding this comment

gradio-pr-bot commented Jun 6, 2024 •

edited

Loading

gradio-pr-bot commented Jun 6, 2024 •

edited

Loading

abidlabs Jun 6, 2024 •

edited

Loading