From c2054f82abbd67045de21e232e0731e6dbac55a0 Mon Sep 17 00:00:00 2001 From: FloatingGhost Date: Fri, 16 Dec 2022 03:32:51 +0000 Subject: [PATCH] allow users with admin:metrics to read app metrics --- .gitignore | 1 + .../controllers/metrics_controller.ex | 10 ++- lib/pleroma/web/plugs/rate_limiter.ex | 6 +- lib/pleroma/web/router.ex | 7 +- lib/pleroma/web/telemetry.ex | 9 +-- lib/pleroma/web/templates/layout/app.html.eex | 32 ++++++--- .../web/templates/layout/static_fe.html.eex | 4 +- .../o_auth/oob_authorization_created.html.eex | 10 ++- .../web/templates/o_auth/o_auth/show.html.eex | 4 +- mix.exs | 2 +- priv/static/static-fe/forms.css | Bin 0 -> 2303 bytes priv/static/static-fe/static-fe.css | Bin 12696 -> 12885 bytes scripts/create_metrics_app.sh | 65 ++++++++++++++++++ test/support/factory.ex | 2 +- 14 files changed, 125 insertions(+), 27 deletions(-) create mode 100644 priv/static/static-fe/forms.css create mode 100755 scripts/create_metrics_app.sh diff --git a/.gitignore b/.gitignore index 14373fb8c..95b236af6 100644 --- a/.gitignore +++ b/.gitignore @@ -76,3 +76,4 @@ docs/site # docker stuff docker-db +*.iml diff --git a/lib/pleroma/web/akkoma_api/controllers/metrics_controller.ex b/lib/pleroma/web/akkoma_api/controllers/metrics_controller.ex index c8d3d8948..8d413bf58 100644 --- a/lib/pleroma/web/akkoma_api/controllers/metrics_controller.ex +++ b/lib/pleroma/web/akkoma_api/controllers/metrics_controller.ex @@ -3,9 +3,13 @@ defmodule Pleroma.Web.AkkomaAPI.MetricsController do alias Pleroma.Web.Plugs.OAuthScopesPlug - @unauthenticated_access %{fallback: :proceed_unauthenticated, scopes: []} - plug(:skip_auth) - + plug( + OAuthScopesPlug, + %{scopes: ["admin:metrics"]} + when action in [ + :show + ] + ) def show(conn, _params) do stats = TelemetryMetricsPrometheus.Core.scrape() diff --git a/lib/pleroma/web/plugs/rate_limiter.ex b/lib/pleroma/web/plugs/rate_limiter.ex index 5bebe0ad5..f5ca27f0c 100644 --- a/lib/pleroma/web/plugs/rate_limiter.ex +++ b/lib/pleroma/web/plugs/rate_limiter.ex @@ -197,7 +197,11 @@ defp incorporate_conn_info(action_settings, %{params: params} = conn) do }) end - defp ip(%{remote_ip: remote_ip}) do + defp ip(%{remote_ip: remote_ip}) when is_binary(remote_ip) do + remote_ip + end + + defp ip(%{remote_ip: remote_ip}) when is_tuple(remote_ip) do remote_ip |> Tuple.to_list() |> Enum.join(".") diff --git a/lib/pleroma/web/router.ex b/lib/pleroma/web/router.ex index c0ce645c4..f47041b0b 100644 --- a/lib/pleroma/web/router.ex +++ b/lib/pleroma/web/router.ex @@ -868,7 +868,11 @@ defmodule Pleroma.Web.Router do scope "/" do pipe_through([:pleroma_html, :authenticate, :require_admin]) - live_dashboard("/phoenix/live_dashboard", metrics: {Pleroma.Web.Telemetry, :live_dashboard_metrics}, csp_nonce_assign_key: :csp_nonce) + + live_dashboard("/phoenix/live_dashboard", + metrics: {Pleroma.Web.Telemetry, :live_dashboard_metrics}, + csp_nonce_assign_key: :csp_nonce + ) end # Test-only routes needed to test action dispatching and plug chain execution @@ -907,6 +911,7 @@ defmodule Pleroma.Web.Router do scope "/", Pleroma.Web.Fallback do get("/registration/:token", RedirectController, :registration_page) get("/:maybe_nickname_or_id", RedirectController, :redirector_with_meta) + get("/api/*path", RedirectController, :api_not_implemented) get("/*path", RedirectController, :redirector_with_preload) options("/*path", RedirectController, :empty) diff --git a/lib/pleroma/web/telemetry.ex b/lib/pleroma/web/telemetry.ex index 435f55799..5b01ee14d 100644 --- a/lib/pleroma/web/telemetry.ex +++ b/lib/pleroma/web/telemetry.ex @@ -11,16 +11,13 @@ def start_link(arg) do def init(_arg) do children = [ {:telemetry_poller, measurements: periodic_measurements(), period: 10_000}, - {TelemetryMetricsPrometheus, metrics: prometheus_metrics(), plug_cowboy_opts: [ip: {127, 0, 0, 1}]} + {TelemetryMetricsPrometheus.Core, metrics: prometheus_metrics()} ] Supervisor.init(children, strategy: :one_for_one) end - @doc """ - A seperate set of metrics for distributions because phoenix dashboard does NOT handle - them well - """ + # A seperate set of metrics for distributions because phoenix dashboard does NOT handle them well defp distribution_metrics do [ distribution( @@ -110,8 +107,6 @@ defp summary_metrics do summary("vm.total_run_queue_lengths.total"), summary("vm.total_run_queue_lengths.cpu"), summary("vm.total_run_queue_lengths.io"), - - last_value("pleroma.local_users.total"), last_value("pleroma.domains.total"), last_value("pleroma.local_statuses.total") diff --git a/lib/pleroma/web/templates/layout/app.html.eex b/lib/pleroma/web/templates/layout/app.html.eex index e33bada85..31e6ec52b 100644 --- a/lib/pleroma/web/templates/layout/app.html.eex +++ b/lib/pleroma/web/templates/layout/app.html.eex @@ -4,17 +4,33 @@ <%= Pleroma.Config.get([:instance, :name]) %> - + + -
- - -

<%= Pleroma.Config.get([:instance, :name]) %>

- -
+ +
+
- <%= @inner_content %> +
+
+
+ <%= @inner_content %> +
+
+ + diff --git a/lib/pleroma/web/templates/layout/static_fe.html.eex b/lib/pleroma/web/templates/layout/static_fe.html.eex index 3d55393f0..d159eb901 100644 --- a/lib/pleroma/web/templates/layout/static_fe.html.eex +++ b/lib/pleroma/web/templates/layout/static_fe.html.eex @@ -20,8 +20,8 @@
-
- <%= @inner_content %> +
+ <%= @inner_content %>
diff --git a/lib/pleroma/web/templates/o_auth/o_auth/oob_authorization_created.html.eex b/lib/pleroma/web/templates/o_auth/o_auth/oob_authorization_created.html.eex index 76ed3fda5..17e54fb42 100644 --- a/lib/pleroma/web/templates/o_auth/o_auth/oob_authorization_created.html.eex +++ b/lib/pleroma/web/templates/o_auth/o_auth/oob_authorization_created.html.eex @@ -1,2 +1,8 @@ -

<%= Gettext.dpgettext("static_pages", "oauth authorized page title", "Successfully authorized") %>

-

<%= raw Gettext.dpgettext("static_pages", "oauth token code message", "Token code is
%{token}", token: safe_to_string(html_escape(@auth.token))) %>

+
+
+ <%= Gettext.dpgettext("static_pages", "oauth authorized page title", "Successfully authorized") %> +
+
+ <%= raw Gettext.dpgettext("static_pages", "oauth token code message", "Token code is
%{token}", token: safe_to_string(html_escape(@auth.token))) %> +
+
diff --git a/lib/pleroma/web/templates/o_auth/o_auth/show.html.eex b/lib/pleroma/web/templates/o_auth/o_auth/show.html.eex index a2f41618e..48c3c5eb9 100644 --- a/lib/pleroma/web/templates/o_auth/o_auth/show.html.eex +++ b/lib/pleroma/web/templates/o_auth/o_auth/show.html.eex @@ -20,7 +20,9 @@
<%= if @app do %> -

<%= raw Gettext.dpgettext("static_pages", "oauth authorize message", "Application %{client_name} is requesting access to your account.", client_name: safe_to_string(html_escape(@app.client_name))) %>

+
+

<%= raw Gettext.dpgettext("static_pages", "oauth authorize message", "Application %{client_name} is requesting access to your account.", client_name: safe_to_string(html_escape(@app.client_name))) %>

+
<%= render @view_module, "_scopes.html", Map.merge(assigns, %{form: f}) %> <% end %> diff --git a/mix.exs b/mix.exs index b5b7efd0c..4898591b1 100644 --- a/mix.exs +++ b/mix.exs @@ -163,7 +163,7 @@ defp deps do {:telemetry, "~> 0.3"}, {:telemetry_poller, "~> 0.4"}, {:telemetry_metrics, "~> 0.4"}, - {:telemetry_metrics_prometheus, "~> 1.1.0"}, + {:telemetry_metrics_prometheus_core, "~> 1.1.0"}, {:poolboy, "~> 1.5"}, {:recon, "~> 2.5"}, {:joken, "~> 2.0"}, diff --git a/priv/static/static-fe/forms.css b/priv/static/static-fe/forms.css new file mode 100644 index 0000000000000000000000000000000000000000..f7196eef6be09ed99e63838939ab1f89a02ac709 GIT binary patch literal 2303 zcmbtVTW;Gh5d8Nk2nPic)HGx#E(!%bN!t%fq%0y5DUeibx9BbU+0*qTUA`<)l92!n z96wg%a%X3DSV`5QpDP4^Cr(YBqg|GLcwYTlt+rfry$KIX*+`Y6SEBAQZhONhHtcM$ zi$6TO1eEKpA(tFg4Lkc#OVp7I+_1_(X4WQA#gFwkY`0;`6)O#wB1e$BZ-uL6TuMhM z<>F{7?b2h6>~eIN1Pf`5Y{#n$QobCO>;?7ZM_AK%fR#Y+6bDR~Iru^<%AiA;hiDWL znp+&WQ?g^qKwtbC>?@kBqrD;?c(#2!X#YIflB0chMp`zUqPsnL{QN}xs!9rjHUGf? z=2OHU_~fEyikq13Y}dK=T~k97E#10=IyD}*dV$efBv}P{wjI&24@vVDbTd1+Aq8vl ziYpD`s(C|$0Bh#evbQ1{c7><63Oy+TlCbX{e^SmOm)F#9WG;y2+N#P?m+QO7$vhCLV?L>joU1G=D>a6eA!_p*5*4gTDoX5$yD6H8w!hVinF2SU?hrA-h7Jf?B`awoh=**89t>S2jt^~hyZkd3+F=`V; z!BV3_;%Fon5!!w7#v2;t?xKCTp(f3XVRwT%a=;4Uit0PKC`zK8fXAL5QZH%F-UwEE zMFZ4toD*H87#^u(LGJg5!v+m+K;Hx6LNhb$!A`&9P1y#8*LAt0HjRD7&7OxlR+p{iL?0|@u+zmWU`aRbWt literal 0 HcmV?d00001 diff --git a/priv/static/static-fe/static-fe.css b/priv/static/static-fe/static-fe.css index 657556077f3a06687670005a6e7e389c29dbc746..606c07d7ed1ef402d82d1ede156ca83f3afcfa9b 100644 GIT binary patch delta 379 zcmX|-ze~eV5XX5*EhY}O)M8s~eL7UCO=&@)rcfMoa8Pg&M6f>do^7D{LGl6xajgHq zDY%LbPFi@IgSa?4s{e;h1qYK_yzRc+=RU_>8}D>*C807rs!Pz48!(iH@GX=7WD@$Z zzL=WWLvR?sQB*uG@e`l@kOI?klrnpPINZ2Jd>uQE$b7pgVHey{u zscE-$Tw@j-rS3NjryE#y<+RIstj8mbL}L0wu%y eIN^b>kx6vCjL z5KLSzwpot-HzQcxOdz?5b01Ju0hb9Ivx1$%=A{A$m?n1%FWP)t#GG-nu-G%^&A%jF zK+5f