Skip to content

Commit

Permalink
REadme fix
Browse files Browse the repository at this point in the history
  • Loading branch information
Sergey committed Feb 9, 2017
1 parent 0c49138 commit 6aabae3
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,17 @@ It has built-in REST API and UI dashboard.

[See Demo page only, returned from Perfon.Net Api](http://perfon.1gb.ru/api/perfcountersui "See Demo page only, returned from Perfon.Net Api")

Install from NuGet: `Install-Package Perfon.WebApi` for using in Asp.Net WebApi projects.
Install from NuGet: `Install-Package Perfon.Mvc` for using in Asp.Net Mvc 5 projects.
Install from NuGet: `Install-Package Perfon.WebApi` [link](https://www.nuget.org/packages/Perfon.WebApi "Nuget link") for using in Asp.Net WebApi projects.

Install from NuGet: `Install-Package Perfon.Mvc` [link](https://www.nuget.org/packages/Perfon.Mvc "Nuget link") for using in Asp.Net Mvc 5 projects.


It is designed mainly for use in WebApi and MVC projects, placed on shared hosting plans, when you have no access to IIS or OS and work without access to IIS or OS, or have non-privileged rights.


It has three built-in storage drivers, allowing to save counters data to CSV file, in embedded LiteDB database (www.litedb.org, SQLite analog) or to keep it in memory cache.
You could develop own storage driver implementing simple interface.
Custom counters could be impelemented easily deriving from Peron.Net base performance counters.
You could develop own storage driver by implementing simple interface.
Custom counters could be impelemented easily deriving from Perfon.Net base performance counters.
Threshold notifications could be set on counters.


Expand All @@ -36,19 +37,16 @@ A list of implemented performance counters:

Perfon.Net provides Web Api for getting performance counters and built-in dashboard:

get counters list: api/perfcounters

get values for selected counter: api/perfcounters?name={name} [&date={date}&skip={number}]

html page dashboard iwth visualization of counters: api/perfcountersui

html div: api/perfcountersuipanel
* get counters list: api/perfcounters
* get values for selected counter: api/perfcounters?name={name} [&date={date}&skip={number}]
* html page dashboard with visualization of counters: api/perfcountersui
* html div: api/perfcountersuipanel


It could be tested on the Demo site: [http://perfon.1gb.ru/api/perfcountersui](http://perfon.1gb.ru/api/perfcountersui "http://perfon.1gb.ru/api/perfcountersui")


Counter values are the same as that of in JMeter and Windows PerfMon for both WebApi and MVC projects.
Counter values have need verified with counters of JMeter and Windows PerfMon for both WebApi and MVC projects.
(TODO: add comparison images)


Expand Down Expand Up @@ -102,7 +100,9 @@ A wrapper for painless use Perfon with Web Mvc 5 projects.
PerfMonitor.Configuration.EnablePerfApi = true;
PerfMonitor.Configuration.EnablePerfUIApi = true;
PerfMonitor.Start(this, RouteTable.Routes, 2000);
```

---
### Perfon.Core
Core library, that monitors performance metrics of your application.
Expand All @@ -114,17 +114,17 @@ It does not uses windows perfomance counters, so it could used with non-privileg
### TestServer
Example of using Perfon.WebApi. One could run and monitor with Perfon using JMeterTests stress tests.

--
---


### TestMvcApp
Example of using Perfon.Mvc.

--
---

License: MIT

--
---

### TODO:
* add sample for custom counter.
Expand Down

0 comments on commit 6aabae3

Please sign in to comment.