[{"_1":2,"_174":-5,"_175":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_149":150},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_87":-5,"_88":89,"_138":-5,"_139":11,"_140":21,"_141":11,"_142":-5,"_143":11,"_144":-5,"_145":146,"_147":90,"_148":-7},"canonicalUrl","https://hub.docker.com/r/bwsw/cs-pulse-server/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","bwsw","reponame","cs-pulse-server","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":35,"_48":11,"_49":50,"_51":52,"_53":54,"_56":35,"_32":33,"_57":58,"_59":44,"_60":61,"_62":61,"_63":64,"_65":-5,"_66":67,"_68":69,"_70":11,"_71":33,"_72":73,"_78":21,"_79":80,"_84":33,"_85":86},"categories",[],"content_types",[44],"image","date_registered","2017-06-09T09:13:05.14051Z","description","is_private","last_updated","2019-02-28T17:14:34.403821Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[55],"application/vnd.docker.container.image.v1+json","name","pull_count",42904,"repository_type","star_count",1,"status","status_description","active","source","collaborator_count",0,"full_description","![Travis-CI build status for master branch](https://travis-ci.org/bwsw/cs-pulse-server.svg?branch=master)\n\n# CS-Umbrella / Pulse Plugin Server Code \n\nRESTful server for bwsw/cs-pulse-sensor datafeed processing\n\n### Server specification\n\n#### Request types\n\n1. CPU time, query param /cputime/uuid/range/aggregation/shift\n* uuid - host uuid\n* range - Data output period - 15m, 30m, 1h, 2h, 4h, 12h, 1d, 1w, 1month and others if configured in the configuration file.\n* shift - 0+ which means N-fold shift in current range\n* aggregation - 1m, 5m, 15m, 1h (aggregation must be less then range), example: range=15m, aggregation=5m, in result we have 3 values for needed data.\n Can have only one parameter which is gotten from a sensor\n \n2. RAM utilization /ram/uuid/range/aggregation/shift\n* Can have only one parameter which is gotten from a sensor\n* Data output should have bits dimension\n\n3. Network utilization /network-interface/uuid/mac/range/aggregation/shift\n* have addition value - mac - mac card address\n* can have many parameters which are gotten from a sensor\n\n4. Disk utilization /disk/uuid/disk-uuid/range/aggregation/shift\n* have addition value disk-uuid\n* can have many parameters which are gotten from a sensor\n\n#### Features:\n\n- [x] Implement with HTTP REST framework Scalatra\n- [x] build and deploy as docker container\n- [x] attach to dockerhub\n- [x] no external database required (except influxdb)\n- [x] implement per-client query limit/sec parameter configurable with ENVARS with Nginx (#20 queries per second) \n- [x] implement behind nginx\n- [x] valid RESTful GET methods according to above specification\n- [x] JSON for responses\n- [x] Configurable nginx cache time (in seconds) for repeatable requests, default 10 seconds\n- [x] Set what kind of aggregation can there be for each range.\n\n\n### Usage:\n```\n# docker pull bwsw/cs-pulse-server\n# docker run --restart=always -d --name pulse-server \\\n -e INFLUX_URL=http://localhost:8086/ \\\n -e INFLUX_USER=puls \\\n -e INFLUX_PASSWORD=secret \\\n -e INFLUX_DB=puls \\\n -e NGINX_CACHE_TIME=15s \\\n -e NGINX_RATE_LIMIT=20 \\\n -v /path/to/app.conf:/etc/pulse/application.conf \\\n -p 80:9090 bwsw/cs-pulse-server\n```\n### Config example:\n```\npulse_config {\n influx {\n url = \"http://localhost:8086\"\n url = ${?INFLUX_URL}\n\n username = \"username\"\n username = ${?INFLUX_USER}\n\n password = \"password\"\n password = ${?INFLUX_PASSWORD}\n\n database = \"database\"\n database = ${?INFLUX_DB}\n }\n scales = [\n {\n range = \"15m\"\n aggregation = [\"1m\", \"5m\"]\n }\n {\n range = \"30m\"\n aggregation = [\"1m\", \"5m\", \"15m\"]\n }\n {\n range = \"1h\"\n aggregation = [\"1m\", \"5m\", \"15m\"]\n }\n {\n range = \"2h\"\n aggregation = [\"5m\", \"15m\", \"30m\"]\n }\n {\n range = \"4h\"\n aggregation = [\"5m\", \"15m\", \"30m\", \"1h\"]\n }\n {\n range = \"12h\"\n aggregation = [\"15m\", \"30m\", \"1h\"]\n }\n {\n range = \"1d\"\n aggregation = [\"30m\", \"1h\"]\n }\n {\n range = \"1w\"\n aggregation = [\"1h\", \"4h\"]\n }\n {\n range = \"30d\"\n aggregation = [\"4h\", \"1d\"]\n }\n {\n range = \"3h\"\n aggregation = [\"4m\", \"6m\"]\n }\n ]\n shifts = [\"m\", \"h\", \"d\"]\n}\n```\n\n### Data json format:\n```\nresults: [\n {\n : ,\n ...\n }, \n {...}\n]\n```\n\n### Metadata json format:\n```\n{\n measurement: ,\n uuid: ,\n range: ,\n aggregation: ,\n shift: ,\n <\n mac: ,\n disk_uuid: ,\n >\n results: [...]\n}\n```\n### Design:\nhttps://github.com/bwsw/cs-pulse-server/wiki/Design\n\n### Request/Response examples:\n\n##### Permitted intervals:\n```\nhttp://hostname/permitted-intervals \n```\n\n##### Cpu request:\n``` \nhttp://hostname/cputime/550e8400-e29b-41d4-a716-446655440000/1d/1h/1w\n```\n##### Cpu response (percents):\n```\n{\n measurement: cputime,\n uuid: 550e8400-e29b-41d4-a716-446655440000,\n range: 1d,\n aggregation: 1h,\n shift: 1w,\n results: \n [\n {\n cpu: 50\n },\n {\n cpu: 70\n },\n {\n cpu: 40\n }\n ]\n}\n```\n\n##### Ram request:\n```\nhttp://hostname/ram/550e8400-e29b-41d4-a716-446655440000/15m/1m/1d\n```\n##### Ram response (KB):\n```\n{\n measurement: ram,\n uuid: 550e8400-e29b-41d4-a716-446655440000,\n range: 15m,\n aggregation: 1m,\n shift: 1d,\n result: \n [\n {\n ram: 3500\n },\n {\n ram: 3300\n },\n {\n ram: 3600\n }\n ]\n}\n```\n\n##### Disk request:\n```\nhttp://hostname/disk/550e8400-e29b-41d4-a716-446655440000/70dc25e9-82c6-4a8c-8d7d-3e304cced576/1h/15m/0s\n```\n##### Disk response:\n```\n{\n measurement: disk,\n uuid: 550e8400-e29b-41d4-a716-446655440000,\n diskUuid: 70dc25e9-82c6-4a8c-8d7d-3e304cced576,\n range: 1h,\n aggregation: 15m,\n shift: 0s,\n result: \n [\n {\n ioErrors: -1,\n readBytes: 4096,\n writeBytes: 2108076032,\n readIOPS: 1,\n writeIOPS: 489850\n },\n {\n ioErrors: -1,\n readBytes: 144589824,\n writeBytes: 1702346752,\n readIOPS: 12802,\n writeIOPS: 169427\n }\n ]\n}\n```\n##### Network request:\n```\nhttp://hostname/network-interface/550e8400-e29b-41d4-a716-446655440000/08:ED:B9:49:B2:E5/1h/15m/0s\n```\n##### Network response: \n```\n{\n measurement: network-interface,\n uuid: 550e8400-e29b-41d4-a716-446655440000,\n mac: 08:ED:B9:49:B2:E5,\n range: 1h,\n aggregation: 15m,\n shift: 0s,\n result: \n [\n {\n readBits: 354920233,\n writeBits: 233636521,\n readErrors: 0,\n writeErrors: 0,\n readDrops: 0,\n writeDrops: 0,\n readPackets: 1644729,\n writePackets: 797443\n },\n {\n readBits: 17842072,\n writeBits: 15747525,\n readErrors: 0,\n writeErrors: 0,\n readDrops: 0,\n writeDrops: 0,\n readPackets: 108813,\n writePackets: 58346\n }\n ]\n}\n```\n\n\n##### Response with null value:\n```\n{\n measurement: cputime,\n uuid: 550e8400-e29b-41d4-a716-446655440000,\n range: 1d,\n aggregation: 1h,\n shift: 1w,\n results: \n [\n {\n cpu: \"50\"\n },\n {\n cpu: \"70\"\n },\n {\n cpu: \"40\"\n },\n {\n cpu: \"\"\n },\n {\n cpu: \"\"\n },\n {\n cpu: \"60\"\n }\n ]\n}\n```\n\n\n##### Empty response:\n```\n{\n measurement: cputime,\n uuid: 550e8400-e29b-41d4-a716-446655440000,\n range: 1d,\n aggregation: 1h,\n shift: 1w,\n results: []\n}\n```\n\n##### Error response:\nResponse status code: 503, 400, 404\n\nResponse example:\n```\n{\n params: {\n measurement: cputime,\n uuid: 550e8400-e29b-41d4-a716,\n range: 1dh,\n aggregation: 1h,\n shift: 1w\n }\n errors: [\n \"Argument range must be in influx time format, with suffix\",\n \"Argument uuid must be in UUID format\"\n ]\n}\n```\n\n\n##### Known error messages:\n```\nPage not found\nArgument not included into allowed interval. See configuration file.\nArgument not matches.\nArgument : argument must be specified firstly.\nArgument must be in influx time format, with suffix.\nArgument must be in UUID format.\n```\n\nAdditional error messages from QueryResult.\n","has_starred","hub_user","immutable_tags_settings",{"_74":11,"_75":76},"enabled","rules",[77],".*","is_automated","permissions",{"_81":21,"_82":11,"_83":11},"read","write","admin","user","storage_size",3127917793,"orgData","recentTags",[90,128],{"_91":44,"_92":93,"_94":95,"_96":97,"_98":99,"_49":117,"_118":93,"_119":33,"_120":55,"_56":121,"_122":123,"_124":108,"_125":117,"_126":64,"_127":21},"content_type","creator",954159,"full_size",271015361,"id",11816774,"images",[100],{"_101":102,"_103":104,"_105":106,"_107":108,"_109":110,"_111":112,"_113":106,"_114":-5,"_115":95,"_62":64,"_116":-5},"architecture","amd64","digest","sha256:50606382a5f47f6c89fd189131591910bf884987b7f06e55243295697558e2bf","features","","last_pulled","2026-10-01T13:29:14.391035831Z","last_pushed","2019-02-28T17:14:35Z","os","linux","os_features","os_version","size","variant","2019-02-28T17:14:34.076452Z","last_updater","last_updater_username","media_type","latest","repository",1558558,"tag_last_pulled","tag_last_pushed","tag_status","v2",{"_91":44,"_92":93,"_94":129,"_96":130,"_98":131,"_49":136,"_118":93,"_119":33,"_120":55,"_56":137,"_122":123,"_124":134,"_125":136,"_126":64,"_127":21},426141335,11722673,[132],{"_101":102,"_103":133,"_105":106,"_107":134,"_109":135,"_111":112,"_113":106,"_114":-5,"_115":129,"_62":64,"_116":-5},"sha256:108de9a2c0274ee3bb1b0c35fc16deb9c7deebdf84c3b1a46978d04d3936e7da","2026-10-01T13:30:14.476594891Z","2017-06-09T09:42:03Z","2017-06-09T09:42:02.305374Z","develop","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":151,"_158":159,"_145":172,"_173":11},{"_40":152,"_42":153,"_45":46,"_47":35,"_48":11,"_49":50,"_51":52,"_53":154,"_56":35,"_32":33,"_57":58,"_59":44,"_60":61,"_62":61,"_63":64,"_65":-5,"_66":67,"_68":69,"_70":11,"_71":33,"_72":155,"_78":21,"_79":157,"_84":33,"_85":86},[],[44],[55],{"_74":11,"_75":156},[77],{"_81":21,"_82":11,"_83":11},"tags",{"_160":161,"_162":-5,"_163":-5,"_164":165},"count",2,"next","previous","results",[166,169],{"_91":44,"_92":93,"_94":95,"_96":97,"_98":167,"_49":117,"_118":93,"_119":33,"_120":55,"_56":121,"_122":123,"_124":108,"_125":117,"_126":64,"_127":21},[168],{"_101":102,"_103":104,"_105":106,"_107":108,"_109":110,"_111":112,"_113":106,"_114":-5,"_115":95,"_62":64,"_116":-5},{"_91":44,"_92":93,"_94":129,"_96":130,"_98":170,"_49":136,"_118":93,"_119":33,"_120":55,"_56":137,"_122":123,"_124":134,"_125":136,"_126":64,"_127":21},[171],{"_101":102,"_103":133,"_105":106,"_107":134,"_109":135,"_111":112,"_113":106,"_114":-5,"_115":129,"_62":64,"_116":-5},[],"canDeleteTags","actionData","errors"]

bwsw/cs-pulse-server

Tags for bwsw/cs-pulse-server