@kong-ui-public/analytics-metric-provider 10.1.3-pr.2477.ec18eb4c8.0 → 10.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/style.css +1 -0
- package/dist/types/components/MetricCardContainer.vue.d.ts +91 -0
- package/dist/types/components/MetricCardContainer.vue.d.ts.map +1 -0
- package/dist/types/components/MetricsConsumer.vue.d.ts +34 -0
- package/dist/types/components/MetricsConsumer.vue.d.ts.map +1 -0
- package/dist/types/components/MetricsProvider.vue.d.ts +51 -0
- package/dist/types/components/MetricsProvider.vue.d.ts.map +1 -0
- package/dist/types/components/MetricsTestHarness.vue.d.ts +26 -0
- package/dist/types/components/MetricsTestHarness.vue.d.ts.map +1 -0
- package/dist/types/components/display/MetricCardLoadingSkeleton.vue.d.ts +3 -0
- package/dist/types/components/display/MetricCardLoadingSkeleton.vue.d.ts.map +1 -0
- package/dist/types/components/display/MetricsCard.vue.d.ts +397 -0
- package/dist/types/components/display/MetricsCard.vue.d.ts.map +1 -0
- package/dist/types/components/metricsProviderUtil.d.ts +36 -0
- package/dist/types/components/metricsProviderUtil.d.ts.map +1 -0
- package/dist/types/composables/index.d.ts +12 -0
- package/dist/types/composables/index.d.ts.map +1 -0
- package/dist/types/composables/useI18n.d.ts +9 -0
- package/dist/types/composables/useI18n.d.ts.map +1 -0
- package/dist/types/composables/useMetricCardBuilder.d.ts +20 -0
- package/dist/types/composables/useMetricCardBuilder.d.ts.map +1 -0
- package/dist/types/composables/useMetricFetcher.d.ts +19 -0
- package/dist/types/composables/useMetricFetcher.d.ts.map +1 -0
- package/dist/types/composables/useRequest.d.ts +12 -0
- package/dist/types/composables/useRequest.d.ts.map +1 -0
- package/dist/types/constants.d.ts +7 -0
- package/dist/types/constants.d.ts.map +1 -0
- package/dist/types/enums/index.d.ts +3 -0
- package/dist/types/enums/index.d.ts.map +1 -0
- package/dist/types/enums/metric-card-size.enum.d.ts +7 -0
- package/dist/types/enums/metric-card-size.enum.d.ts.map +1 -0
- package/dist/types/enums/metric-card-type.enum.d.ts +7 -0
- package/dist/types/enums/metric-card-type.enum.d.ts.map +1 -0
- package/dist/types/index.d.ts +8 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/mockExploreResponse.d.ts +11 -0
- package/dist/types/mockExploreResponse.d.ts.map +1 -0
- package/dist/types/types/fetcher-types.d.ts +17 -0
- package/dist/types/types/fetcher-types.d.ts.map +1 -0
- package/dist/types/types/index.d.ts +3 -0
- package/dist/types/types/index.d.ts.map +1 -0
- package/dist/types/types/metric-card.d.ts +36 -0
- package/dist/types/types/metric-card.d.ts.map +1 -0
- package/dist/types/utilities/index.d.ts +2 -0
- package/dist/types/utilities/index.d.ts.map +1 -0
- package/dist/types/utilities/trend-display.d.ts +24 -0
- package/dist/types/utilities/trend-display.d.ts.map +1 -0
- package/dist/vitals-metric-provider.es.js +1190 -0
- package/dist/vitals-metric-provider.umd.js +1 -0
- package/package.json +8 -8
|
@@ -0,0 +1 @@
|
|
|
1
|
+
(function(R,t){typeof exports=="object"&&typeof module<"u"?t(exports,require("vue"),require("@kong-ui-public/analytics-utilities"),require("@kong-ui-public/i18n"),require("axios"),require("@kong-ui-public/analytics-config-store"),require("@kong/icons")):typeof define=="function"&&define.amd?define(["exports","vue","@kong-ui-public/analytics-utilities","@kong-ui-public/i18n","axios","@kong-ui-public/analytics-config-store","@kong/icons"],t):(R=typeof globalThis<"u"?globalThis:R||self,t(R["kong-ui-public-vitals-metric-provider"]={},R.Vue,R["kong-ui-public-analytics-utilities"],R["kong-ui-public-i18n"],R.axios,R["kong-ui-public-analytics-config-store"],R.KongIcons))})(this,function(R,t,D,re,Rr,Te,_){"use strict";const Ce={general:{notAvailable:"N/A"},metricCard:{small:{traffic:"Requests",errorRate:"Error rate",averageLatency:"Avg. latency",p99Latency:"P99 latency"},short:{traffic:"Requests",errorRate:"Error rate",averageLatency:"Average latency",p99Latency:"P99 latency"},long:{traffic:"Number of requests",errorRate:"Average error rate",averageLatency:"Average latency",p99Latency:"P99 latency"}},trendRange:{custom_days:"vs previous {numDays, plural, =1 {day} other {# days}}",custom_hours:"vs previous {numHours, plural, =1 {hour} other {# hours}}",custom_minutes:"vs previous {numMinutes, plural, =1 {minute} other {# minutes}}","15m":"vs previous 15 minutes","1h":"vs previous hour","6h":"vs previous 6 hours","12h":"vs previous 12 hours","24h":"vs previous 24 hours","7d":"vs previous 7 days","30d":"vs previous 30 days",current_week:"vs previous week",current_month:"vs previous month",current_quarter:"vs previous quarter",previous_week:"vs previous time period",previous_month:"vs previous time period",previous_quarter:"vs previous quarter"}};function Se(){const e=re.createI18n("en-us",Ce);return{i18n:e,i18nT:re.i18nTComponent(e)}}const te=2,w=["1XX","2XX","3XX","4XX","5XX"],K=["4XX","5XX"],_e=["1XX","2XX","3XX"],ne=30*1e3,ae="analytics-query-provider";var ie=(e=>(e.VALIDATING="VALIDATING",e.VALIDATING_HAS_DATA="VALIDATING_HAS_DATA",e.PENDING="PENDING",e.SUCCESS="SUCCESS",e.SUCCESS_HAS_DATA="SUCCESS_HAS_DATA",e.ERROR="ERROR",e.STALE_IF_ERROR="STALE_IF_ERROR",e))(ie||{});const Ie=e=>{var r,n,s,i,a;return e?!!((r=Object.keys(e))!=null&&r.length||(n=e.data)!=null&&n.length||(i=(s=e.data)==null?void 0:s.data)!=null&&i.length||!((a=e.data)!=null&&a.data)&&typeof e.data=="object"&&Object.keys(e==null?void 0:e.data).length):!1};function ke(e=t.ref({}),r,n,s=Ie){const i=t.ref("PENDING");return t.watchEffect(()=>{const a=s(e.value);if(e.value&&a&&n.value){i.value="VALIDATING_HAS_DATA";return}if(e.value&&n.value){i.value="VALIDATING";return}if(e.value&&r.value){i.value="STALE_IF_ERROR";return}if(e.value===void 0&&!r.value){i.value="PENDING";return}if(e.value&&!r.value&&a){i.value="SUCCESS_HAS_DATA";return}if(e.value&&!r.value){i.value="SUCCESS";return}e.value===void 0&&r&&(i.value="ERROR")}),{state:i,swrvState:ie}}const V=Symbol("default"),U="status_code_grouped",oe=(e,r,n,s,i)=>{e[r][n]||(e[r][n]={}),e[r][n][s]=i};function Ae(e,r){var d;const n=((d=e.meta.metric_names)==null?void 0:d[0])||"",s=e.meta.start_ms,i=Object.keys(e.meta.display||{}),a=!!i.find(m=>m===U),u=i.find(m=>m!==U);return i.length>2||i.length>1&&!a?(console.error("Don't know how to work with provided dimensions:",i),{previous:{[V]:{[V]:0}},current:{[V]:{[V]:0}}}):e.data.reduce((m,o)=>{const l=o.event[n],c=u?o.event[u]:V,f=a?o.event[U]:V;return new Date(o.timestamp).getTime()===s&&r?oe(m,"previous",c,f,l):oe(m,"current",c,f,l),m},{previous:{},current:{}})}function De(e){e.queryReady===void 0&&(e.queryReady=t.computed(()=>!0));const{i18n:r}=N.useI18n(),n=t.computed(()=>{var c,f;return{metrics:e.metrics.value,dimensions:[...(c=e.dimensions)!=null&&c.length?[...e.dimensions]:[],...e.withTrend.value?["time"]:[]],granularity:e.withTrend.value?"trend":void 0,...(f=e.filter.value)!=null&&f.length?{filters:e.filter.value}:{},time_range:e.timeframe.value.v4Query(e.tz.value)}}),s=t.computed(()=>{var f,y,p,E;if(!((f=e.queryReady)!=null&&f.value))return null;const c=(y=e.filter)!=null&&y.value?JSON.stringify(e.filter.value):"";return`metric-fetcher-${e.timeframe.value.cacheKey()}-${(p=e.dimensions)==null?void 0:p.join("-")}-${(E=e.metrics.value)==null?void 0:E.join("-")}-${c}-${e.refreshCounter.value}`}),{response:i,error:a,isValidating:u}=N.useRequest(()=>s.value,()=>e.queryFn({datasource:e.datasource.value,query:n.value},e.abortController??new AbortController),{refreshInterval:e.refreshInterval,revalidateOnFocus:!1,errorRetryCount:te}),{state:d,swrvState:m}=ke(i,a,u),o=t.computed(()=>{var c,f,y,p,E,h,T;return!((f=(c=i.value)==null?void 0:c.data)!=null&&f.length)||!((p=(y=i.value)==null?void 0:y.meta)!=null&&p.display)||!((T=(h=(E=i.value)==null?void 0:E.meta)==null?void 0:h.metric_names)!=null&&T.length)?{current:{},previous:{}}:Ae(i.value,e.withTrend.value)}),l=t.computed(()=>{var c,f;if(e.timeframe.value.key==="custom"){if(!((f=(c=i.value)==null?void 0:c.meta)!=null&&f.start_ms))return"";const{start_ms:y,end_ms:p}=i.value.meta;let E=(p-y)/(1e3*60*60*24),h=(p-y)/(1e3*60*60),T=(p-y)/(1e3*60);return e.withTrend.value&&(E/=2,h/=2,T/=2),E>=1?r.t("trendRange.custom_days",{numDays:Math.round(E)}):h>=1?r.t("trendRange.custom_hours",{numHours:Math.round(h)}):T>=1?r.t("trendRange.custom_minutes",{numMinutes:Math.round(T)}):r.t("trendRange.custom_days",{numDays:Math.round(E)})}else return e.withTrend.value?r.t(`trendRange.${e.timeframe.value.key}`):""});return{isLoading:t.computed(()=>m.PENDING===d.value),hasError:t.computed(()=>m.ERROR===d.value),raw:i,mapped:o,trendRange:l}}const L=(e,r,n=V,s)=>(s??[V]).reduce((a,u)=>{const d=e[r][n];return d?a+(d[u]||0):a},0);function be(e){const{cardType:r,title:n,description:s,record:i,hasError:a,increaseIsBad:u,formatValueFn:d,trendRange:m}=e;return t.computed(()=>{let o=0,l=0;if(i!=null&&i.value)try{o=L(i.value,"current",e.lookupKey,e.sumGroupedValues),l=L(i.value,"previous",e.lookupKey,e.sumGroupedValues)}catch(c){console.error("Metric card data doesn't have the expected structure:",c)}return{cardType:r,hasError:a.value,currentValue:o,previousValue:l,title:n.value,description:s,increaseIsBad:!!u,formatValueFn:d,trendRange:m==null?void 0:m.value}})}var $=new WeakMap,se=0;function Ve(e){if(!e.length)return"";for(var r="arg",n=0;n<e.length;++n){var s=void 0;e[n]===null||typeof e[n]!="object"&&typeof e[n]!="function"?typeof e[n]=="string"?s='"'+e[n]+'"':s=String(e[n]):$.has(e[n])?s=$.get(e[n]):(s=se,$.set(e[n],se++)),r+="@"+s}return r}function Ne(e){if(typeof e=="function")try{e=e()}catch{e=""}return Array.isArray(e)?e=Ve(e):e=String(e||""),e}var X=function(){function e(r){r===void 0&&(r=0),this.items=new Map,this.ttl=r}return e.prototype.serializeKey=function(r){return Ne(r)},e.prototype.get=function(r){var n=this.serializeKey(r);return this.items.get(n)},e.prototype.set=function(r,n,s){var i=this.serializeKey(r),a=s||this.ttl,u=Date.now(),d={data:n,createdAt:u,expiresAt:a?u+a:1/0};this.dispatchExpire(a,d,i),this.items.set(i,d)},e.prototype.dispatchExpire=function(r,n,s){var i=this;r&&setTimeout(function(){var a=Date.now(),u=a>=n.expiresAt;u&&i.delete(s)},r)},e.prototype.delete=function(r){this.items.delete(r)},e}();function Oe(){return typeof navigator.onLine<"u"?navigator.onLine:!0}function we(){return typeof document<"u"&&typeof document.visibilityState<"u"?document.visibilityState!=="hidden":!0}var Le=function(e){return fetch(e).then(function(r){return r.json()})};const G={isOnline:Oe,isDocumentVisible:we,fetcher:Le};var b=function(){return b=Object.assign||function(e){for(var r,n=1,s=arguments.length;n<s;n++){r=arguments[n];for(var i in r)Object.prototype.hasOwnProperty.call(r,i)&&(e[i]=r[i])}return e},b.apply(this,arguments)},M=function(e,r,n,s){function i(a){return a instanceof n?a:new n(function(u){u(a)})}return new(n||(n=Promise))(function(a,u){function d(l){try{o(s.next(l))}catch(c){u(c)}}function m(l){try{o(s.throw(l))}catch(c){u(c)}}function o(l){l.done?a(l.value):i(l.value).then(d,m)}o((s=s.apply(e,r||[])).next())})},F=function(e,r){var n={label:0,sent:function(){if(a[0]&1)throw a[1];return a[1]},trys:[],ops:[]},s,i,a,u;return u={next:d(0),throw:d(1),return:d(2)},typeof Symbol=="function"&&(u[Symbol.iterator]=function(){return this}),u;function d(o){return function(l){return m([o,l])}}function m(o){if(s)throw new TypeError("Generator is already executing.");for(;n;)try{if(s=1,i&&(a=o[0]&2?i.return:o[0]?i.throw||((a=i.return)&&a.call(i),0):i.next)&&!(a=a.call(i,o[1])).done)return a;switch(i=0,a&&(o=[o[0]&2,a.value]),o[0]){case 0:case 1:a=o;break;case 4:return n.label++,{value:o[1],done:!1};case 5:n.label++,i=o[1],o=[0];continue;case 7:o=n.ops.pop(),n.trys.pop();continue;default:if(a=n.trys,!(a=a.length>0&&a[a.length-1])&&(o[0]===6||o[0]===2)){n=0;continue}if(o[0]===3&&(!a||o[1]>a[0]&&o[1]<a[3])){n.label=o[1];break}if(o[0]===6&&n.label<a[1]){n.label=a[1],a=o;break}if(a&&n.label<a[2]){n.label=a[2],n.ops.push(o);break}a[2]&&n.ops.pop(),n.trys.pop();continue}o=r.call(e,n)}catch(l){o=[6,l],i=0}finally{s=a=0}if(o[0]&5)throw o[1];return{value:o[0]?o[1]:void 0,done:!0}}},Me=function(e,r){var n=typeof Symbol=="function"&&e[Symbol.iterator];if(!n)return e;var s=n.call(e),i,a=[],u;try{for(;(r===void 0||r-- >0)&&!(i=s.next()).done;)a.push(i.value)}catch(d){u={error:d}}finally{try{i&&!i.done&&(n=s.return)&&n.call(s)}finally{if(u)throw u.error}}return a},Fe=function(e,r,n){if(n||arguments.length===2)for(var s=0,i=r.length,a;s<i;s++)(a||!(s in r))&&(a||(a=Array.prototype.slice.call(r,0,s)),a[s]=r[s]);return e.concat(a||Array.prototype.slice.call(r))},le=new X,q=new X,j=new X,ce={cache:le,refreshInterval:0,ttl:0,serverTTL:1e3,dedupingInterval:2e3,revalidateOnFocus:!0,revalidateDebounce:0,shouldRetryOnError:!0,errorRetryInterval:5e3,errorRetryCount:5,fetcher:G.fetcher,isOnline:G.isOnline,isDocumentVisible:G.isDocumentVisible};function Be(e,r,n){var s=q.get(e);if(s)s.data.push(r);else{var i=5e3;q.set(e,[r],n>0?n+i:n)}}function qe(e,r,n){if(n.isDocumentVisible()&&!(n.errorRetryCount!==void 0&&r>n.errorRetryCount)){var s=Math.min(r||0,n.errorRetryCount),i=s*n.errorRetryInterval;setTimeout(function(){e(null,{errorRetryCount:s+1,shouldRetryOnError:!0})},i)}}var ue=function(e,r,n,s){return n===void 0&&(n=le),s===void 0&&(s=ce.ttl),M(void 0,void 0,void 0,function(){var i,a,u,d,m,o,l;return F(this,function(c){switch(c.label){case 0:if(!ze(r))return[3,5];c.label=1;case 1:return c.trys.push([1,3,,4]),[4,r];case 2:return i=c.sent(),[3,4];case 3:return d=c.sent(),a=d,[3,4];case 4:return[3,6];case 5:i=r,c.label=6;case 6:if(u=!1,m={data:i,error:a,isValidating:u},typeof i<"u")try{n.set(e,m,s)}catch(f){console.error("swrv(mutate): failed to set cache",f)}return o=q.get(e),o&&o.data.length&&(l=o.data.filter(function(f){return f.key===e}),l.forEach(function(f,y){typeof m.data<"u"&&(f.data=m.data),f.error=m.error,f.isValidating=m.isValidating,f.isLoading=m.isValidating;var p=y===l.length-1;p||delete l[y]}),l=l.filter(Boolean)),[2,m]}})})};function xe(){for(var e=this,r=[],n=0;n<arguments.length;n++)r[n]=arguments[n];var s,i,a=b({},ce),u=!1,d=!1,m=t.getCurrentInstance(),o=(m==null?void 0:m.proxy)||m;if(!o)return console.error("Could not get current instance, check to make sure that `useSwrv` is declared in the top level of the setup function."),null;var l=(o==null?void 0:o.$isServer)||!1;r.length>=1&&(s=r[0]),r.length>=2&&(i=r[1]),r.length>2&&(a=b(b({},a),r[2]));var c=l?a.serverTTL:a.ttl,f=typeof s=="function"?s:t.ref(s);typeof i>"u"&&(i=a.fetcher);var y=null;y||(y=t.reactive({data:void 0,error:void 0,isValidating:!0,isLoading:!0,key:null}));var p=function(v,g){return M(e,void 0,void 0,function(){var S,C,A,B,W,pe,J,ve=this;return F(this,function(Z){switch(Z.label){case 0:return S=y.data===void 0,C=f.value,C?(A=a.cache.get(C),B=A&&A.data,y.isValidating=!0,y.isLoading=!B,B&&(y.data=B.data,y.error=B.error),W=v||i,!W||!a.isDocumentVisible()&&!S||(g==null?void 0:g.forceRevalidate)!==void 0&&!(g!=null&&g.forceRevalidate)?(y.isValidating=!1,y.isLoading=!1,[2]):A&&(pe=!!(Date.now()-A.createdAt>=a.dedupingInterval||g!=null&&g.forceRevalidate),!pe)?(y.isValidating=!1,y.isLoading=!1,[2]):(J=function(){return M(ve,void 0,void 0,function(){var O,Ee,ee,Re;return F(this,function(P){switch(P.label){case 0:return O=j.get(C),O?[3,2]:(Ee=Array.isArray(C)?C:[C],ee=W.apply(void 0,Fe([],Me(Ee),!1)),j.set(C,ee,a.dedupingInterval),[4,ue(C,ee,a.cache,c)]);case 1:return P.sent(),[3,4];case 2:return[4,ue(C,O.data,a.cache,c)];case 3:P.sent(),P.label=4;case 4:return y.isValidating=!1,y.isLoading=!1,j.delete(C),y.error!==void 0&&(Re=!u&&a.shouldRetryOnError&&(g?g.shouldRetryOnError:!0),Re&&qe(p,g?g.errorRetryCount:1,a)),[2]}})})},B&&a.revalidateDebounce?(setTimeout(function(){return M(ve,void 0,void 0,function(){return F(this,function(O){switch(O.label){case 0:return u?[3,2]:[4,J()];case 1:O.sent(),O.label=2;case 2:return[2]}})})},a.revalidateDebounce),[3,3]):[3,1])):[2];case 1:return[4,J()];case 2:Z.sent(),Z.label=3;case 3:return[2]}})})},E=function(){return M(e,void 0,void 0,function(){return F(this,function(v){return[2,p(null,{shouldRetryOnError:!1})]})})},h=null;t.onMounted(function(){var v=function(){return M(e,void 0,void 0,function(){return F(this,function(g){switch(g.label){case 0:return!y.error&&a.isOnline()?[4,p()]:[3,2];case 1:return g.sent(),[3,3];case 2:h&&clearTimeout(h),g.label=3;case 3:return a.refreshInterval&&!u&&(h=setTimeout(v,a.refreshInterval)),[2]}})})};a.refreshInterval&&(h=setTimeout(v,a.refreshInterval)),a.revalidateOnFocus&&(document.addEventListener("visibilitychange",E,!1),window.addEventListener("focus",E,!1))}),t.onUnmounted(function(){u=!0,h&&clearTimeout(h),a.revalidateOnFocus&&(document.removeEventListener("visibilitychange",E,!1),window.removeEventListener("focus",E,!1));var v=q.get(f.value);v&&(v.data=v.data.filter(function(g){return g!==y}))});try{t.watch(f,function(v){t.isReadonly(f)||(f.value=v),y.key=v,y.isValidating=!!v,Be(f.value,y,c),!l&&!d&&f.value&&p(),d=!1},{immediate:!0})}catch{}var T=b(b({},t.toRefs(y)),{mutate:function(v,g){return p(v,b(b({},g),{forceRevalidate:!0}))}});return T}function ze(e){return e!==null&&typeof e=="object"&&typeof e.then=="function"}function Pe(e,r,n){const{data:s,error:i,isValidating:a,mutate:u}=xe(e,r,{revalidateDebounce:500,revalidateOnFocus:!1,dedupingInterval:100,...n});return{data:t.computed(()=>s.value),response:s,error:i,isValidating:a,revalidate:u}}const N={useI18n:Se,useMetricCardBuilder:be,useMetricFetcher:De,useRequest:Pe},de=Symbol("METRICS_PROVIDER_KEY"),Ke=e=>{const{datasource:r,dimension:n,dimensionFilterValue:s,additionalFilter:i,queryReady:a,timeframe:u,tz:d,hasTrendAccess:m,refreshInterval:o,abortController:l,queryFn:c,averageLatencies:f}=e;if(s&&!n)throw new Error("Must provide a dimension if filtering by a value");const y=!!(n&&s),p=!!(n&&!s),E=t.computed(()=>{const S=[];return y&&S.push({field:n,operator:"in",value:[s]}),i.value&&S.push(...D.stripUnknownFilters(r.value,i.value)),S}),h={datasource:r,metrics:t.ref(["request_count"]),dimensions:[...n&&!y?[n]:[],"status_code_grouped"],filter:E,queryReady:a,timeframe:u,tz:d,withTrend:t.computed(()=>m.value&&!p),refreshInterval:o,queryFn:c,abortController:l,refreshCounter:e.refreshCounter},T={datasource:r,metrics:t.computed(()=>[f.value?"response_latency_average":"response_latency_p99"]),...n&&!y?{dimensions:[n]}:{},filter:E,queryReady:a,timeframe:u,tz:d,withTrend:t.computed(()=>m.value&&!p),refreshInterval:o,queryFn:c,abortController:l,refreshCounter:e.refreshCounter},v=N.useMetricFetcher(h),g=N.useMetricFetcher(T);return{trafficData:v,latencyData:g}},Ue=t.defineComponent({__name:"MetricsProvider",props:{datasource:{default:void 0},maxTimeframe:{default:D.TimeframeKeys.THIRTY_DAY},overrideTimeframe:{default:void 0},tz:{default:void 0},dimension:{default:void 0},filterValue:{default:void 0},additionalFilter:{default:void 0},queryReady:{type:Boolean,default:!0},refreshInterval:{default:ne},longCardTitles:{type:Boolean,default:!1},containerTitle:{default:void 0},description:{default:void 0},percentileLatency:{type:Boolean,default:void 0},abortController:{default:void 0},refreshCounter:{default:0}},setup(e){const r=e;if(r.dimension&&D.queryableExploreDimensions.findIndex(y=>y===r.dimension)===-1)throw new Error(`Attempted to use MetricsProvider with an invalid dimension: ${r.dimension}`);const n=t.inject(ae);let s;n?s=n.queryFn:(console.warn("Analytics dashboards require a query bridge supplied via provide / inject."),console.warn("Please ensure your application has a query bridge provided under the key 'analytics-query-provider', as described in"),console.warn("https://github.com/Kong/public-ui-components/blob/main/packages/analytics/analytics-metric-provider/README.md#requirements"),s=()=>Promise.reject(new Error("Query bridge required")));const i=Te.useAnalyticsConfigStore(),a=t.computed(()=>!0),u=t.computed(()=>!i.loading&&r.queryReady),d=t.computed(()=>r.tz?r.tz:new Intl.DateTimeFormat().resolvedOptions().timeZone),m=t.computed(()=>r.datasource?r.datasource:"basic"),o=t.computed(()=>r.overrideTimeframe||D.TimePeriods.get(D.TimeframeKeys.SEVEN_DAY)),l=t.computed(()=>!r.percentileLatency),{trafficData:c,latencyData:f}=Ke({datasource:m,dimension:r.dimension,dimensionFilterValue:r.filterValue,additionalFilter:t.toRef(r,"additionalFilter"),queryReady:u,timeframe:o,tz:d,hasTrendAccess:a,refreshInterval:r.refreshInterval,queryFn:s,averageLatencies:l,abortController:r.abortController,refreshCounter:t.toRef(r,"refreshCounter")});return t.provide(de,{data:{traffic:c,latency:f},description:t.toRef(()=>r.description),containerTitle:t.toRef(()=>r.containerTitle),hasTrendAccess:a,longCardTitles:r.longCardTitles,averageLatencies:l}),(y,p)=>t.renderSlot(y.$slots,"default",{hasTrendAccess:a.value,timeframe:o.value})}});function $e(e){return e&&e.__esModule&&Object.prototype.hasOwnProperty.call(e,"default")?e.default:e}var fe={exports:{}};(function(e){(function(){function r(o,l){if(l.separator===!1||o<1e3)return o.toString();var c=typeof l.separator=="string"?l.separator:",",f=[],y=Math.round(o).toString().split("");return y.reverse().forEach(function(p,E){E&&E%3===0&&f.push(c),f.push(p)}),f.reverse().join("")}function n(o,l,c){var f=o/l,y=c.round?"round":"floor";return c.decimal===!1?(o=Math[y](f),o.toString()):(c.precision?o=f:o=f<10?Math[y](f*10)/10:Math[y](f),o=o.toString(),typeof c.decimal=="string"&&(o=o.replace(".",c.decimal)),o)}var s=1e3,i=1e4,a=1e6,u=1e9,d=1e12;function m(o,l){var c;l=l||{};var f=o<0;f&&(o=Math.abs(o)),l.precision&&(o=parseFloat(o.toPrecision(l.precision)));var y=l.min10k?i:s;return o<y||l.precision&&l.precision>Math.log10(o)?c=r(n(o,1,l),l):o<a?c=n(o,s,l)+"k":o<u?c=n(o,a,l)+"m":o<d?c=r(n(o,u,l),l)+"b":c=r(n(o,d,l),l)+"t",f&&(c="-"+c),l.capital&&(c=c.toUpperCase()),l.prefix&&(c=l.prefix+c),l.suffix&&(c=c+l.suffix),c}m.addCommas=r,e.exports=m})()})(fe);var Xe=fe.exports;const Ge=$e(Xe);var k=(e=>(e.GENERIC_COUNT="GenericCount",e.TRAFFIC="Traffic",e.ERROR_RATE="ErrorRate",e.LATENCY="Latency",e))(k||{}),I=(e=>(e.Small="sm",e.Medium="md",e.Large="lg",e.ExtraLarge="xl",e))(I||{});const H=2,me=H+2,je=(e,r,n=!1)=>{let s=!r||Number(e.toFixed(me))===0?0:Number(e.toFixed(me))>0?1:-1;return n&&(s*=-1),s},He=(e,r,n)=>r?`${Math.abs(e*100).toFixed(H)}%`:n,Ye=(e,r)=>r===0?0:e/r-1,Qe=(e,r=!1)=>(r&&(e*=-1),e>0?_.TrendUpIcon:e<0?_.TrendDownIcon:_.IndeterminateSmallIcon),We="#ad000e",Y="#6c7489",ye="#52596e",Je="#007d60",x="16px",Ze="20px",er={key:0,class:"metricscard-description"},rr={class:"metricscard-valuetrend"},tr={key:0,class:"metricscard-error"},nr={key:2,class:"metricscard-trend"},ar={"data-testid":"metric-trend-change"},ir={key:0,class:"metricscard-trend-range"},or=t.defineComponent({__name:"MetricsCard",props:{cardType:{type:String,required:!0,default:k.GENERIC_COUNT},title:{type:String,default:"0%",required:!0},description:{type:String,default:"",required:!1},tooltip:{type:String,required:!1,default:""},timeframe:{type:String,required:!1,default:""},metricValue:{type:String,default:""},metricChange:{type:String,required:!0},changePolarity:{type:Number,required:!0},trendIcon:{type:Object,default:_.IndeterminateSmallIcon},trendRange:{type:String,default:""},hasError:{type:Boolean,default:!1},errorMessage:{type:String,default:"Vitals data error"},cardSize:{type:String,required:!1,default:()=>I.Large},hasContainerTitle:{type:Boolean,required:!1,default:!1},titleTag:{type:String,default:"span"}},setup(e){const r=new Map([[k.GENERIC_COUNT,_.VitalsIcon],[k.TRAFFIC,_.CloudUploadIcon],[k.ERROR_RATE,_.WarningOutlineIcon],[k.LATENCY,_.ResponseIcon]]),n=e,s=d=>{const m={red:`var(--kui-color-text-danger-strong, ${We})`,green:`var(--kui-color-text-success, ${Je})`,grey:`var(--kui-color-text-neutral-strong, ${ye})`};return d>0?m.green:d<0?m.red:m.grey},i=d=>d>0?"positive":d<0?"negative":"neutral",a=[I.Medium,I.Large].includes(n.cardSize),u=[I.Small].includes(n.cardSize);return(d,m)=>{const o=t.resolveComponent("KTooltip");return t.openBlock(),t.createElementBlock("div",{class:t.normalizeClass(["metricscard",e.cardSize])},[t.createElementVNode("div",{class:t.normalizeClass(["metricscard-title",e.cardSize])},[t.unref(u)?t.createCommentVNode("",!0):(t.openBlock(),t.createBlock(t.resolveDynamicComponent(t.unref(r).get(e.cardType)),{key:0,class:"metricscard-icon",color:`var(--kui-color-text-neutral, ${t.unref(Y)})`,size:t.unref(x)},null,8,["color","size"])),(t.openBlock(),t.createBlock(t.resolveDynamicComponent(e.titleTag),null,{default:t.withCtx(()=>[t.createTextVNode(t.toDisplayString(e.title),1)]),_:1})),e.tooltip?(t.openBlock(),t.createBlock(o,{key:1,class:"metricscard-tooltip",placement:"right",text:e.tooltip},{default:t.withCtx(()=>[t.createVNode(t.unref(_.InfoIcon),{color:`var(--kui-color-text-neutral, ${t.unref(Y)})`,size:t.unref(x)},null,8,["color","size"])]),_:1},8,["text"])):t.createCommentVNode("",!0)],2),e.description&&t.unref(a)?(t.openBlock(),t.createElementBlock("div",er,[t.createElementVNode("span",null,t.toDisplayString(e.description),1)])):t.createCommentVNode("",!0),t.createElementVNode("div",rr,[e.hasError?(t.openBlock(),t.createElementBlock("div",tr,[t.createVNode(t.unref(_.WarningIcon),{color:`var(--kui-color-text-neutral, ${t.unref(Y)})`,size:t.unref(Ze)},null,8,["color","size"]),t.createElementVNode("div",null," "+t.toDisplayString(e.errorMessage),1)])):(t.openBlock(),t.createElementBlock("div",{key:1,class:t.normalizeClass(["metricscard-value",e.cardSize]),"data-testid":"metric-value"},t.toDisplayString(e.metricValue),3)),t.unref(a)?(t.openBlock(),t.createElementBlock("div",nr,[t.createElementVNode("div",{class:t.normalizeClass(["metricscard-trend-change",i(e.changePolarity)]),"data-testid":"metric-trend-parent"},[e.changePolarity!==0?(t.openBlock(),t.createBlock(t.resolveDynamicComponent(e.trendIcon),{key:0,color:s(e.changePolarity),size:t.unref(x)},null,8,["color","size"])):(t.openBlock(),t.createBlock(t.unref(_.EqualIcon),{key:1,color:`var(--kui-color-text-neutral-strong, ${t.unref(ye)})`,size:t.unref(x)},null,8,["color","size"])),t.createElementVNode("div",ar,t.toDisplayString(e.metricChange),1)],2),e.trendRange?(t.openBlock(),t.createElementBlock("div",ir,t.toDisplayString(e.trendRange),1)):t.createCommentVNode("",!0)])):t.createCommentVNode("",!0)])],2)}}}),Q=(e,r)=>{const n=e.__vccOpts||e;for(const[s,i]of r)n[s]=i;return n},sr=Q(or,[["__scopeId","data-v-b1513f6f"]]),lr={},cr={class:"loading-tabs"};function ur(e,r){const n=t.resolveComponent("KSkeletonBox");return t.openBlock(),t.createElementBlock("div",cr,[t.createVNode(n,{width:"100"}),t.createVNode(n,{width:"75"})])}const dr=Q(lr,[["render",ur],["__scopeId","data-v-9c7113d7"]]),fr={key:0,class:"container-title"},mr={key:0,class:"container-description"},yr={key:1,class:"error-display"},hr={key:0,class:"error-display-message"},gr={key:2,class:"cards-wrapper"},pr=Q(t.defineComponent({__name:"MetricCardContainer",props:{fallbackDisplayText:{type:String,required:!0},cards:{type:Array,required:!0},errorMessage:{type:String,required:!1,default:""},loading:{type:Boolean,required:!1,default:!1},hasTrendAccess:{type:Boolean,required:!1,default:!0},cardSize:{type:String,required:!1,default:()=>I.Large},containerTitle:{type:String,required:!1,default:""},containerDescription:{type:String,required:!1,default:""}},setup(e){const r=e,n=t.computed(()=>r.cards.every(i=>(i==null?void 0:i.hasError)===!0)),s=i=>{const a=Ye(i.currentValue,i.previousValue)||0,u=je(a,r.hasTrendAccess,i.increaseIsBad);return{metricValue:i.formatValueFn?i.formatValueFn(i.currentValue):Ge(i.currentValue,{capital:!0,round:!0})||"0",metricChange:i.formatChangeFn?i.formatChangeFn(a):He(a,r.hasTrendAccess,r.fallbackDisplayText),changePolarity:u,trendIcon:Qe(u,i.increaseIsBad),cardSize:r.cardSize,hasContainerTitle:!!r.containerTitle}};return(i,a)=>(t.openBlock(),t.createElementBlock("div",{class:t.normalizeClass(["kong-ui-public-metric-card-container",e.cardSize])},[r.containerTitle||r.containerDescription?(t.openBlock(),t.createElementBlock("div",fr,[t.createTextVNode(t.toDisplayString(r.containerTitle)+" ",1),r.containerDescription?(t.openBlock(),t.createElementBlock("div",mr,t.toDisplayString(r.containerDescription),1)):t.createCommentVNode("",!0)])):t.createCommentVNode("",!0),n.value?(t.openBlock(),t.createElementBlock("div",yr,[t.createVNode(t.unref(_.WarningIcon),{class:"error-display-icon"}),e.errorMessage?(t.openBlock(),t.createElementBlock("div",hr,t.toDisplayString(e.errorMessage),1)):t.createCommentVNode("",!0)])):(t.openBlock(),t.createElementBlock("div",gr,[(t.openBlock(!0),t.createElementBlock(t.Fragment,null,t.renderList(e.cards,(u,d)=>(t.openBlock(),t.createElementBlock(t.Fragment,null,[e.loading?(t.openBlock(),t.createElementBlock("div",{key:`skeleton-${d}`,class:"loading-tab"},[t.createVNode(dr,{class:t.normalizeClass(e.cardSize===t.unref(I).Small?"loading-tabs-small":"loading-tabs-large")},null,8,["class"])])):(t.openBlock(),t.createBlock(sr,t.mergeProps({key:d},{ref_for:!0},s(u),{"card-size":e.cardSize,"card-type":u.cardType,description:u.description,"error-message":e.errorMessage,"has-error":u.hasError,title:u.title,"title-tag":u.titleTag,tooltip:u.tooltip,"trend-range":u.trendRange}),null,16,["card-size","card-type","description","error-message","has-error","title","title-tag","tooltip","trend-range"]))],64))),256))]))],2))}}),[["__scopeId","data-v-7080ba56"]]),vr=t.defineComponent({__name:"MetricsConsumer",props:{lookupKey:{default:void 0},cardSize:{default:I.Large},cardToDisplay:{default:void 0}},setup(e){const r=e,n=t.inject(de);if(!n)throw new Error("MetricsConsumer must be nested inside a MetricsProvider instance.");const{traffic:s,latency:i}=n.data,{i18n:a}=N.useI18n(),u=t.computed(()=>n.containerTitle.value?I.Medium:r.cardSize),d=N.useMetricCardBuilder({cardType:k.TRAFFIC,title:t.computed(()=>n.longCardTitles?a.t("metricCard.long.traffic"):a.t("metricCard.short.traffic")),record:s.mapped,hasError:s.hasError,lookupKey:r.lookupKey,sumGroupedValues:w,trendRange:s.trendRange}),m=h=>`${h.toFixed(H)}%`,o=t.computed(()=>{const h=s.mapped.value,T=L(h,"current",r.lookupKey,K),v=L(h,"current",r.lookupKey,w),g=T/v*100||0,S=L(h,"previous",r.lookupKey,K),C=L(h,"previous",r.lookupKey,w),A=S/C*100||0;return{cardType:k.ERROR_RATE,hasError:s.hasError.value,currentValue:g,previousValue:A,formatValueFn:m,title:n.longCardTitles?a.t("metricCard.long.errorRate"):a.t("metricCard.short.errorRate"),increaseIsBad:!0,trendRange:s.trendRange.value}}),l=h=>`${h}ms`,c=N.useMetricCardBuilder({cardType:k.LATENCY,title:t.computed(()=>{const{longCardTitles:h,averageLatencies:T}=n,v=T.value?"averageLatency":"p99Latency";return h?a.t(`metricCard.long.${v}`):u.value===I.Small?a.t(`metricCard.small.${v}`):a.t(`metricCard.short.${v}`)}),hasError:i.hasError,record:i.mapped,lookupKey:r.lookupKey,increaseIsBad:!0,formatValueFn:l,trendRange:i.trendRange}),f=t.computed(()=>r.cardToDisplay==="TRAFFIC"?[d.value]:r.cardToDisplay==="ERROR_RATE"?[o.value]:r.cardToDisplay==="LATENCY"?[c.value]:[d.value,o.value,c.value]),y=t.computed(()=>r.cardToDisplay==="TRAFFIC"||r.cardToDisplay==="ERROR_RATE"?s.isLoading.value:r.cardToDisplay==="LATENCY"?i.isLoading.value:s.isLoading.value||i.isLoading.value),p=t.computed(()=>({cards:f.value,containerTitle:n.containerTitle.value,containerDescription:n.description.value,loading:y.value,hasTrendAccess:n.hasTrendAccess.value,fallbackDisplayText:a.t("general.notAvailable"),cardSize:u.value,hideTitle:!0})),E=t.computed(()=>({loading:p.value.loading,trafficCard:d.value,errorRateCard:o.value,latencyCard:c.value,errorRateFormatted:m(o.value.currentValue),latencyFormatted:l(c.value.currentValue)}));return(h,T)=>t.renderSlot(h.$slots,"default",{cardValues:E.value},()=>[t.createVNode(pr,t.normalizeProps(t.guardReactiveProps(p.value)),null,16)])}}),z=e=>new Date(e),Er=(e,r)=>{const n=e.body;e.reply({statusCode:200,body:ge(n,r)})},he=e=>e.reduce((r,n)=>(r[n]={name:n},r),{}),ge=(e,r)=>{var p,E;const n=(r==null?void 0:r.timeFrame)||D.TimePeriods.get(D.TimeframeKeys.ONE_DAY),s=e.granularity==="trend"?new D.DeltaQueryTime(n):new D.UnaryQueryTime(n),i=s.endMs(),a=s.startMs(),u=s.granularityMs(),d=e.granularity==="trend"?2:1;if((e.dimensions??[]).length>2)throw new Error(`Explore only supports 0-2 dimensions; got: ${JSON.stringify(e.dimensions)}`);const m=(e.dimensions??[]).find(h=>h!=="time"),o=(r==null?void 0:r.dimensionNames)??[],l=Math.max(o.length,1),c=e.metrics||[],f=[];for(let h=0;h<d;h++)for(let T=0;T<l;T++){const v=m?{[m]:o[T]}:{};(p=e.dimensions)!=null&&p.includes("status_code_grouped")?w.forEach(g=>{const S=c.reduce((C,A)=>((r==null?void 0:r.deterministic)??!0?C[A]=(d-h)*1e3+100*T+1:C[A]=Math.round(Math.random()*1e3),C),{...v,status_code_grouped:g});f.push({version:"v1",timestamp:h===0?z(a).toISOString():z(a+u).toISOString(),event:S})}):f.push({version:"v1",timestamp:h===0?z(a).toISOString():z(a+u).toISOString(),event:c.reduce((g,S)=>((r==null?void 0:r.deterministic)??!0?g[S]=(d-h)*1e3+100*T+1:g[S]=Math.round(Math.random()*1e3),g),{...v})})}const y={start_ms:a,end_ms:i,start:new Date(a).toISOString(),end:new Date(i).toISOString(),granularity_ms:u,display:m?{[m]:he(o),...(E=e.dimensions)!=null&&E.includes("status_code_grouped")?{status_code_grouped:he(w)}:{}}:{},metric_names:e.metrics,query_id:"test"};return{data:f,meta:y}};R.ALL_STATUS_CODE_GROUPS=w,R.DEFAULT_REFRESH_INTERVAL=ne,R.INJECT_QUERY_PROVIDER=ae,R.MAX_ANALYTICS_REQUEST_RETRIES=te,R.MetricCardSize=I,R.MetricCardType=k,R.MetricsConsumer=vr,R.MetricsProvider=Ue,R.STATUS_CODES_FAILED=K,R.STATUS_CODES_SUCCESS=_e,R.mockExploreResponse=ge,R.mockExploreResponseFromCypress=Er,Object.defineProperty(R,Symbol.toStringTag,{value:"Module"})});
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kong-ui-public/analytics-metric-provider",
|
|
3
|
-
"version": "10.1.3
|
|
3
|
+
"version": "10.1.3",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"main": "./dist/vitals-metric-provider.umd.js",
|
|
6
6
|
"module": "./dist/vitals-metric-provider.es.js",
|
|
@@ -32,25 +32,25 @@
|
|
|
32
32
|
"extends": "../../../package.json"
|
|
33
33
|
},
|
|
34
34
|
"dependencies": {
|
|
35
|
-
"@kong/icons": "^1.
|
|
35
|
+
"@kong/icons": "^1.37.0",
|
|
36
36
|
"approximate-number": "^2.1.1",
|
|
37
37
|
"axios": "^1.7.7",
|
|
38
38
|
"swrv": "^1.1.0",
|
|
39
|
-
"@kong-ui-public/core": "^1.11.
|
|
39
|
+
"@kong-ui-public/core": "^1.11.3"
|
|
40
40
|
},
|
|
41
41
|
"peerDependencies": {
|
|
42
|
-
"@kong/kongponents": "^9.
|
|
42
|
+
"@kong/kongponents": "^9.40.1",
|
|
43
43
|
"@kong-ui-public/analytics-config-store": "^1.1.7",
|
|
44
|
-
"@kong-ui-public/
|
|
45
|
-
"@kong-ui-public/
|
|
44
|
+
"@kong-ui-public/i18n": "^2.4.4",
|
|
45
|
+
"@kong-ui-public/analytics-utilities": "^11.1.0"
|
|
46
46
|
},
|
|
47
47
|
"devDependencies": {
|
|
48
48
|
"@kong/design-tokens": "1.18.0",
|
|
49
49
|
"@kong/kongponents": "9.40.1",
|
|
50
50
|
"pinia": ">= 2.1.7 < 3",
|
|
51
|
-
"@kong-ui-public/analytics-config-store": "^1.1.7",
|
|
52
51
|
"@kong-ui-public/analytics-utilities": "^11.1.0",
|
|
53
|
-
"@kong-ui-public/i18n": "^2.4.4"
|
|
52
|
+
"@kong-ui-public/i18n": "^2.4.4",
|
|
53
|
+
"@kong-ui-public/analytics-config-store": "^1.1.7"
|
|
54
54
|
},
|
|
55
55
|
"scripts": {
|
|
56
56
|
"dev": "cross-env USE_SANDBOX=true vite",
|