Skip to content

Commit 6da859a

Browse files
authored
Merge pull request #7 from SolarEdgeTech/readme-cleanups
Clean up some sections in the Readme
2 parents 6601bfd + cd22d4b commit 6da859a

File tree

1 file changed

+25
-18
lines changed

1 file changed

+25
-18
lines changed

README.md

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44

55
# Pyctuator
66

7-
Monitoring your Python microservices as if they were Spring
8-
Boot applications using
7+
Monitor Python web apps using
98
[Spring Boot Admin](https://github.com/codecentric/spring-boot-admin).
109

11-
The supported web frameworks are **Flask** and **FastAPI**.
10+
Pyctuator supports **Flask** and **FastAPI**. **Django** support is planned as well.
1211

13-
Support for **Django** is planned as well.
14-
15-
The following video shows Spring Boot Admin to monitoring and controlling an instance of the [Advanced example](examples/Advanced/README.md):
12+
The following video shows a FastAPI web app being monitored and controled using Spring Boot Admin.
13+
1614
![Pyctuator Example](examples/images/Pyctuator_Screencast.gif)
1715

16+
The complete example can be found in [Advanced example](examples/Advanced/README.md).
17+
1818
## Requirements
1919
Python 3.7+
2020

@@ -30,10 +30,13 @@ These organizations often use Spring Actuator together with Spring Boot Admin
3030
to monitor their microservices' status, gain access to applications'
3131
state and configuration, manipulate log levels, etc.
3232

33-
These organizations often have the occasional Python microservice, especially as
34-
Python Machine Learning and Data Science packages gain popularity. Setting up
35-
a proper monitoring tool for these microservices is a complex task, and might
36-
not be justified for a few Python microservices in a sea of Java microservices.
33+
While Spring Boot is suitable for many use-cases, it is very common for organizations
34+
to also have a couple of Python microservices, as Python is often more suitable for
35+
some types of applications. The most common examples are Data Science and Machine Learning
36+
applications.
37+
38+
Setting up a proper monitoring tool for these microservices is a complex task, and might
39+
not be justified for just a few Python microservices in a sea of Java microservices.
3740

3841
This is where Pyctuator comes in. It allows you to easily integrate your Python
3942
microservices into your existing Spring Boot Admin deployment.
@@ -48,11 +51,11 @@ It currently supports the following Actuator features:
4851
* **Metrics**
4952
* Memory usage
5053
* Disk usage
51-
* Easily add custom metrics
54+
* Custom metrics
5255
* **Health monitors**
5356
* Built in MySQL health monitor
5457
* Built in Redis health monitor
55-
* Easily add custom health monitors
58+
* Custom health monitors
5659
* **Environment**
5760
* **Loggers** - Easily change log levels during runtime
5861
* **Log file** - Tail the application's log file
@@ -71,7 +74,7 @@ docker run --rm --name spring-boot-admin -p 8082:8082 michayaak/spring-boot-admi
7174
Then go to `http://localhost:8082` to get to the web UI.
7275

7376
### Flask
74-
The following is a complete example and should run as is:
77+
The following example is complete and should run as is.
7578

7679
```python
7780
from flask import Flask
@@ -97,10 +100,12 @@ Pyctuator(
97100
app.run(debug=False, port=5000)
98101
```
99102

100-
Once you run the application, it should automatically register with Spring Boot Admin and should be available in the UI at `http://localhost:8082`
103+
The application will automatically register with Spring Boot Admin upon start up.
104+
105+
Log in to the Spring Boot Admin UI at `http://localhost:8082` to interact with the application.
101106

102107
### FastAPI
103-
The following is a complete example and should run as is:
108+
The following example is complete and should run as is.
104109

105110
```python
106111
from fastapi import FastAPI
@@ -130,15 +135,17 @@ Pyctuator(
130135
Server(config=(Config(app=app, loop="asyncio"))).run()
131136
```
132137

138+
The application will automatically register with Spring Boot Admin upon start up.
133139

134-
Once you run the application, it should automatically register with Spring Boot Admin and should be available in the UI at `http://localhost:8082`
140+
Log in to the Spring Boot Admin UI at `http://localhost:8082` to interact with the application.
135141

136142
## Advanced Configuration
137143
The following sections are intended for advanced users who want to configure advanced Pyctuator features.
138144

139145
### Application Info
140-
While Pyctuator only needs to know the application's name, it is recommended that applications monitored by Spring
141-
Boot Admin will show additional build and git details - this becomes handy when a service is scaled out to multiple instances by showing the version of each instance.
146+
While Pyctuator only needs to know the application's name, we recommend that applications monitored by Spring
147+
Boot Admin will show additional build and git details.
148+
This becomes handy when scaling out a service to multiple instances by showing the version of each instance.
142149
To do so, you can provide additional build and git info using methods of the Pyctuator object:
143150

144151
```python

0 commit comments

Comments
 (0)