{"id":15372089,"url":"https://github.com/xquery/dashml","last_synced_at":"2025-10-11T03:31:43.255Z","repository":{"id":141753228,"uuid":"11983979","full_name":"xquery/dashML","owner":"xquery","description":"create responsive, lightweight dashboards with MarkLogic 7","archived":true,"fork":false,"pushed_at":"2014-09-08T09:12:37.000Z","size":33087,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-16T12:21:12.056Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"XQuery","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xquery.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-08-08T18:56:24.000Z","updated_at":"2023-06-13T07:59:30.000Z","dependencies_parsed_at":"2023-03-12T16:21:11.669Z","dependency_job_id":null,"html_url":"https://github.com/xquery/dashML","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xquery%2FdashML","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xquery%2FdashML/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xquery%2FdashML/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xquery%2FdashML/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xquery","download_url":"https://codeload.github.com/xquery/dashML/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":236031298,"owners_count":19084065,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-01T13:49:33.848Z","updated_at":"2025-10-11T03:31:37.943Z","avatar_url":"https://github.com/xquery.png","language":"XQuery","readme":"# dashML v0.1\n\ndashML is built with [RXQ](https://github.com/xquery/rxq) and included in that repo as an example of building RESTful apps with MarkLogic.\n\nI thought it would be fun to cook up a little bauble that leverages new [features](http://docs.marklogic.com/guide/relnotes/chap3) found in MarkLogic 7.\n\n[MarkLogic 7.0](http://developer.marklogic.com) introduces more tools for monitoring the performance of your MarkLogic server. dashML leverages these [tools](http://docs.marklogic.com/guide/monitoring/history) to make it easy to create lightweight, dashboards giving you up-to-date information on the health and performance of your applications.\n\ndashML provides a tabbed interface of MarkLogic server history monitoring metrics.\n![dashML](src/xquery/resources/history-screenshot.jpg) \n\nThis provides a snapshot of the health of your server which you can view on your smart phone, tablet or any browser that supports responsive templates.\n## Requirements\n\n[MarkLogic 7.0](http://developer.marklogic.com) (latest version)\n\n## To install\n\nFirst, you need to download and install MarkLogic 7.\n\nSecond, create an appserver, providing the following details;\n\n* **root**: provide directory where dashml/src/xquery was copied to your filesystem (ex. /opt/dashml/src/xquery)\n* **port**: choose a port ####\n* **set database**: set to Meters database\n* **set error handler**: /rxq-rewriter.xqy?mode=error\n* **set rewrite handler**: /rxq-rewriter.xqy?mode=rewrite\n\nIf you are installing on a brand new ML7 instance, you may have to wait a little while to give a chance for some metrics to be collected before building (and viewing) dashboards.\n\nWith everything setup, you can now point your web browser to http://localhost:####  (where ### is the port number you choose when setting up appserver) and you should see dashML homepage.\n\nClick onto instructions tab or go direct to building dashboards.\n\n## Using dashML\n\nJust goto http://localhost:####/instructions\n\nthen start building simple dashboards.\n\n## To install/run tests\n\ncreate an appserver, providing the following details;\n\n* **root**: provide directory where dashml/src ison your filesystem\n* **port**: choose a port ####\n* **set database**: set to Meters database\n* amend src/test/dash-model line 59 to point to full path where etc/dash.xsd is\n\nNow point your web browser to http://localhost:####/xray which will run all tests.\n\n## FAQ\n\n* 'X is not working' - make sure you have run long enough for meters to be generated (or switch to last 60 minutes)\n* submit an [issue](https://github.com/xquery/dashML/issues)\n\n## TODO\n\nsome thoughts on future features\n\n* make widgets and dash standalone (consume json endpoints)\n* add resource selection\n* different widget types\n* add replica to database\n* customise everything (colors, etc)\n* reordering\n* add thresholds for alerting\n* add start \u0026 end selection\n\n## Caveat Emptor\n\n* time constraints = quick code generate ('though there are some xray unit tests' he says in a hopeful tone ...)\n* I made GET do bad things (as in not idempotent)\n* no error checking (other then schema validation)\n* probably a long list of other things done poorly ...\n\n## License\n\ndashML is released under Apache License, Version 2.0\n\n## More Info on technologies\n\nThe following are links on the other technologies used in this application.\n\n* RXQ github [repository](https://github.com/xquery/rxq).\n* [purecss](http://purecss.io/) - css templates\n* [EXQuery RESTXQ Draft Specification](http://exquery.github.com/exquery/exquery-restxq-specification/restxq-1.0-specification.html#method-annotation).\n* Adam Retter's [RESTXQ](http://archive.xmlprague.cz/2012/presentations/RESTful_XQuery.pdf).\n* [JSR-311](http://download.oracle.com/otndocs/jcp/jaxrs-1.0-fr-eval-oth-JSpec/).\n \nThe usage of RESTXQ annotations turns out to be a very concise way of building up flexible RESTFul interfaces, as well as providing the basis from which to create MVC architectures for our XQuery web applications.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxquery%2Fdashml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxquery%2Fdashml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxquery%2Fdashml/lists"}