Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

api: Create platform metrics API #184

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

api: Create platform metrics API #184

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 43 additions & 14 deletions api/handler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,21 +130,21 @@ func (h *apiHandler) viewershipHandler() chi.Router {

// TODO: Remove this deprecated endpoint once we know no one is using it
h.withMetrics(router, "get_total_views").
With(h.cache(false)).
With(h.cache(false, "")).
MethodFunc("GET", fmt.Sprintf(`/{%s}/total`, assetIDParam), h.getTotalViews)

// total views public API
h.withMetrics(router, "query_total_viewership").
With(h.cache(false)).
With(h.cache(false, "")).
MethodFunc("GET", fmt.Sprintf(`/query/total/{%s}`, playbackIDParam), h.queryTotalViewership)
// creator views API, requires assetId or streamId on the query-string
h.withMetrics(router, "query_creator_viewership").
With(h.cache(true)).
With(h.cache(true, "")).
With(ensureIsCreatorQuery).
MethodFunc("GET", `/query/creator`, h.queryViewership(false))
// full application views API, gets access to all metrics and filters
h.withMetrics(router, "query_application_viewership").
With(h.cache(true)).
With(h.cache(true, "")).
MethodFunc("GET", `/query`, h.queryViewership(true))

return router
Expand All @@ -153,27 +153,34 @@ func (h *apiHandler) viewershipHandler() chi.Router {
func (h *apiHandler) usageHandler() chi.Router {
opts := h.opts

router := chi.NewRouter()
var router chi.Router = chi.NewRouter()
if h.usage == nil {
router.Handle("/*", notImplemented())
return router
}

authRouter := router
if opts.AuthURL != "" {
router.Use(authorization(opts.AuthURL))
authRouter = router.With(authorization(opts.AuthURL))
}

h.withMetrics(router, "query_usage").
With(h.cache(true)).
h.withMetrics(authRouter, "query_usage").
With(h.cache(true, "")).
MethodFunc("GET", `/query`, h.queryUsage())

h.withMetrics(router, "query_total_usage").
With(h.cache(true)).
h.withMetrics(authRouter, "query_total_usage").
With(h.cache(true, "")).
MethodFunc("GET", `/query/total`, h.queryTotalUsage())

h.withMetrics(router, "query_active_users").
With(h.cache(true)).
h.withMetrics(authRouter, "query_active_users").
With(h.cache(true, "")).
MethodFunc("GET", `/query/active`, h.queryActiveUsersUsage())

// platform metrics public API
h.withMetrics(router, "query_platform_usage").
With(h.cache(false, "public, max-age=3600, stale-while-revalidate=21600, stale-if-error=86400")).
MethodFunc("GET", `/query/platform`, h.queryPlatformUsage())

return router
}

Expand All @@ -186,12 +193,15 @@ func (h *apiHandler) withMetrics(router chi.Router, name string) chi.Router {
})
}

func (h *apiHandler) cache(varyAuth bool) middleware {
func (h *apiHandler) cache(varyAuth bool, cacheControl string) middleware {
return func(next http.Handler) http.Handler {
next = httpCache.Middleware(next)

return http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
rw.Header().Set("Cache-Control", "public, max-age=60, s-maxage=300, stale-while-revalidate=3600, stale-if-error=86400")
if cacheControl == "" {
cacheControl = "public, max-age=60, s-maxage=300, stale-while-revalidate=3600, stale-if-error=86400"
}
rw.Header().Set("Cache-Control", cacheControl)

if varyAuth {
rw.Header().Add("Vary", "Authorization")
Expand Down Expand Up @@ -444,6 +454,25 @@ func (h *apiHandler) queryActiveUsersUsage() http.HandlerFunc {
}
}

func (h *apiHandler) queryPlatformUsage() http.HandlerFunc {
return func(rw http.ResponseWriter, r *http.Request) {
// TODO: Make some real query here
query := usage.QuerySpec{
// TODO
}

usage, err := h.usage.QuerySummary(r.Context(), query)
if err != nil {
respondError(rw, http.StatusInternalServerError, err)
return
}

// TODO: probably process/clean-up the output format

respondJson(rw, http.StatusOK, usage)
}
}

func (h *apiHandler) getTotalViews(rw http.ResponseWriter, r *http.Request) {
assetID := apiParam(r, assetIDParam)

Expand Down
Loading