Metrics: Count of Number of files in themes

freddyDOTCMS commented 9 months ago

Parent Issue

https://github.com/dotCMS/core/issues/27137

User Story

Being able to retrieve the Count of Number of files in themes and include it as part as the /dotexp/stats Endpoint response

Acceptance Criteria

Include a new attribute on the /dotexp/stats Endpoint with the Count of Number of files in themes

Proposed Objective

Core Features

Proposed Priority

Priority 2 - Important

External Links... Slack Conversations, Support Tickets, Figma Designs, etc.

No response

Assumptions & Initiation Needs

No response

Quality Assurance Notes & Workarounds

No response

Sub-Tasks & Estimates

No response

github-actions[bot] commented 6 months ago

This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 30 days.

dsilvam commented 4 months ago

PR: https://github.com/dotCMS/com.dotcms.telemetry/pull/62

freddyDOTCMS commented 4 months ago

Note to QA: Steps to test:

Comment this lines: https://github.com/dotCMS/core/blob/25dbabae5d58e69eb4f91a576869f644c127f1f9/osgi-base/system-bundles/pom.xml#L63-L76
Now the Telemetry plugins is not going to be a System Plugin anymore
Build and start dotCMS
Install the Plugin: Go to Tools/Plugins and click the Upload Button. Select the latest version of the Plugin on the File System.
Hit this endpoint http://localhost:8082/api/v1/telemetry/stats
Look for the Metric TOTAL_LIVE_FILES_IN_THEMES and TOTAL_FILES_IN_THEMES, the value should be equals to all the files under the /application/themes folder, the right value is a little more then 200 files so I don't recommend you to count this files

To check what is the right value for this Metric:

Go to Site Layout/Browser
Go to the /application/themes, All the Sub Folders here are themes.
Let create a New Theme, Create a new SubFolder in '/application/themes', copy the template.vtl file from another theme
check the Metric again and both Metric should be plus 1.
Now Create another File in this new SubFolder just Save (Don't publish), TOTAL_FILES_IN_THEMES must be plus 1 but TOTAL_LIVE_FILES_IN_THEMES must keep the same.
Publish the last File created and TOTAL_LIVE_FILES_IN_THEMES must be plus 1.
Archived the File and both metric must be minus 1.

oidacra commented 4 months ago

IQA Failed: Original values: 218

After creating the new subfolder and copying the template expected TOTAL_FILES_IN_THEMES 219 expected TOTAL_LIVE_FILES_IN_THEMES 219

Has 220 each.

freddyDOTCMS commented 4 months ago

IQA Failed: Original values: 218

After creating the new subfolder and copying the template expected TOTAL_FILES_IN_THEMES 219 expected TOTAL_LIVE_FILES_IN_THEMES 219

Has 220 each.

It is working as expected but I found another bug. To create a Theme is need to: Create a SubFolder in the 'application/themes' and also create a template.vtl file inside this SubFolder. Right now if we create a SubFolder in 'application/themes' and create a File inside it but not the 'template.vtl' file then this file is count even when this SubFolder is not really a Theme

dsilvam commented 4 months ago

PR: Count of all templates used in LIVE pages

oidacra commented 4 months ago

IQA Passed:

oidacra commented 4 months ago

@freddyDOTCMS is it ok if we count the pages?

dotCMS / core