9 Commits

Author SHA1 Message Date
2c58ffd698 chore: add extra require schema 2023-08-04 12:11:31 +08:00
57ff3be326 chore: remove useless dependencies 2023-08-04 10:15:13 +08:00
44ecc83e1a docs: update readme 2023-08-01 17:16:11 +08:00
ab47aa2551 chore: bump python-on-whales to 0.64.0 2023-08-01 14:39:37 +08:00
18ec9b259b docs: update README.md 2023-08-01 14:09:27 +08:00
19deb5473d docs: fix typo in README.md 2023-08-01 13:01:44 +08:00
e480218d3e style and docs 2023-08-01 12:56:01 +08:00
90d64a7981 chore: update extras_require for setup.py 2023-07-28 17:53:03 +08:00
c35e7195f3 feat: add metrics for nameko services 2023-07-28 11:39:41 +08:00
3 changed files with 44 additions and 41 deletions

View File

@@ -1,8 +1,10 @@
# namekoplus
[![Upload Python Package](https://github.com/Bryanthelol/namekoplus/actions/workflows/python-publish.yml/badge.svg?event=release)](https://github.com/Bryanthelol/namekoplus/actions/workflows/python-publish.yml)
A lightweight Python distributed microservice solution
## Command Line Tool Usage
## CLI Usage
### Checkout Command
@@ -27,5 +29,5 @@ namekoplus init --directory <dir_name> --type <template_type>
See Documents:
- [中文](https://doc.bearcatlog.com/)
- [English](https://legendary-sopapillas-e2626d.netlify.app/)
- [English](https://murl.vip/TwML)
- [中文](https://murl.vip/B0O9)

View File

@@ -1,4 +1,3 @@
import importlib
import inspect
import os
import shutil
@@ -10,6 +9,10 @@ import shortuuid
from python_on_whales import DockerException, ClientNotFoundError, DockerClient, docker
from mako.template import Template
INIT_TYPE_CHOICES = ['all', 'rpc', 'event', 'http', 'timer', 'demo']
MIDDLEWARE_CHOICES = ['rabbitmq', 'metrics']
TEST_TYPE_CHOICES = ['unit']
def check_docker():
"""
@@ -132,7 +135,7 @@ def start_grafana():
grafana_conf_dir = os.path.join(get_directory('chassis-agent'), 'metric-configs')
grafana_provisioning_path = os.path.join(grafana_conf_dir, 'grafana_conf/provisioning')
grafana_config_path = os.path.join(grafana_conf_dir, 'grafana_conf/config/grafana.ini')
grafana_dashboard_path = os.path.join(grafana_conf_dir, 'grafana_conf/dashboards')
grafana_dashboard_path = os.path.join('.', 'grafana_dashboards')
returned_string = docker.run(image='grafana/grafana:latest', name='grafana', hostname='grafana',
detach=True, restart='always', tty=True, interactive=True,
publish=[(3100, 3000)], pull='missing',
@@ -154,6 +157,7 @@ def stop_network(network_name):
def start_metric_servers():
# TODO 检查相应容器是否已启动,如果启动,则先删除
start_network('metric_servers')
sleep(0.5)
start_prometheus()
@@ -233,7 +237,7 @@ def cli():
@click.option('-t', '--type', '_type',
default='all',
show_default=True,
type=click.Choice(['all', 'rpc', 'event', 'http', 'timer', 'demo'], case_sensitive=False),
type=click.Choice(INIT_TYPE_CHOICES, case_sensitive=False),
help='The template type of nameko service')
def init(directory, _type):
"""
@@ -258,7 +262,7 @@ def init(directory, _type):
@cli.command()
@click.option('-m', '--middleware',
required=True,
type=click.Choice(['rabbitmq', 'metrics'], case_sensitive=False),
type=click.Choice(MIDDLEWARE_CHOICES, case_sensitive=False),
help='The middleware name')
def start(middleware):
"""
@@ -271,7 +275,7 @@ def start(middleware):
@cli.command()
@click.option('-m', '--middleware',
required=True,
type=click.Choice(['rabbitmq', 'metrics'], case_sensitive=False),
type=click.Choice(MIDDLEWARE_CHOICES, case_sensitive=False),
help='The middleware name')
def stop(middleware):
"""
@@ -288,7 +292,7 @@ def stop(middleware):
@click.option('-t', '--type', '_type',
default='unit',
show_default=True,
type=click.Choice(['unit'], case_sensitive=False),
type=click.Choice(TEST_TYPE_CHOICES, case_sensitive=False),
help='The test type of the nameko service')
def test_gen(directory, _type):
"""
@@ -319,13 +323,12 @@ def metric_config_gen(module, class_name_str):
"""
import sys
from statsd.client.timer import Timer
sys.path.append(os.getcwd())
click.echo(f'sys.path: {sys.path}')
sys.path.append(os.getcwd())
# Extract information of statsd config from the class of nameko service
dest_dir = module.split('.')[0]
file_name = module.split('.')[-1]
_module = __import__(module)
config_list = []
for class_name in class_name_str.split(','):
members = inspect.getmembers(getattr(getattr(_module, file_name), class_name), predicate=inspect.isfunction)
@@ -342,24 +345,30 @@ def metric_config_gen(module, class_name_str):
})
# Generate one file of statsd config yaml for statsd exporter
metric_configs_dir = os.path.join(get_directory('chassis-agent'), 'metric-configs')
template_file_path = os.path.join(metric_configs_dir, 'statsd_mapping.yml.mako')
output_file = os.path.join('.', 'statsd_mapping.yml')
template_to_file(template_file=template_file_path, dest=output_file, output_encoding='utf-8',
**{'config_list': config_list})
with status(f'Creating statsd_mapping.yml'):
metric_configs_dir = os.path.join(get_directory('chassis-agent'), 'metric-configs')
template_file_path = os.path.join(metric_configs_dir, 'statsd_mapping.yml.mako')
output_file = os.path.join('.', 'statsd_mapping.yml')
template_to_file(template_file=template_file_path, dest=output_file, output_encoding='utf-8',
**{'config_list': config_list})
# Generate files of json for grafana dashboard
for class_name in class_name_str.split(','):
grafana_list = []
for config in config_list:
if config['class_name'] == class_name:
grafana_list.append(config)
grafana_configs_dir = os.path.join(get_directory('chassis-agent'), 'metric-configs')
grafana_file_path = os.path.join(grafana_configs_dir, 'grafana.json.mako')
output_file = os.path.join(dest_dir, f'{class_name}_Grafana.json')
template_to_file(template_file=grafana_file_path, dest=output_file, output_encoding='utf-8',
**{'service_name': class_name, 'uid': shortuuid.uuid(),
'grafana_list': grafana_list})
if not os.access('grafana_dashboards', os.F_OK):
with status(f'Creating directory {os.path.abspath("grafana_dashboards")!r}'):
os.makedirs('grafana_dashboards')
with status(f'Creating files of Grafana.json into the directory of grafana_dashboards'):
for class_name in class_name_str.split(','):
grafana_list = []
for config in config_list:
if config['class_name'] == class_name:
grafana_list.append(config)
grafana_configs_dir = os.path.join(get_directory('chassis-agent'), 'metric-configs')
grafana_file_path = os.path.join(grafana_configs_dir, 'grafana.json.mako')
output_file = os.path.join('grafana_dashboards', f'{class_name}_Grafana.json')
template_to_file(template_file=grafana_file_path, dest=output_file, output_encoding='utf-8',
**{'service_name': class_name, 'uid': shortuuid.uuid(),
'grafana_list': grafana_list})
if __name__ == '__main__':

View File

@@ -9,7 +9,7 @@ with open(path.join(here, 'README.md'), encoding='utf-8') as f:
setup(
name='namekoplus',
version='0.4.0',
version='0.4.8',
description='A lightweight Python distributed microservice solution',
long_description=long_description,
long_description_content_type='text/markdown',
@@ -50,7 +50,7 @@ setup(
install_requires=[
'nameko==3.0.0rc11',
'click==8.1.5',
'python-on-whales==0.63.0',
'python-on-whales==0.64.0',
'pytest==7.4.0',
'mako==1.2.4',
'shortuuid==1.0.11'
@@ -59,19 +59,11 @@ setup(
'ha': ['tenacity==8.2.2',
'cachetools==5.3.0',
'circuitbreaker==2.0.0',
'statsd==4.0.1',
'logstash_formatter==0.5.17',
'logstash_formatter==0.5.17'],
'ob': ['statsd==4.0.1',
'nameko-sentry==1.0.0',
'nameko-tracer==1.4.0'],
'apiflask': ['apiflask>=1.3.1',
'gevent>=22.10.2',
'gunicorn==20.1.0'],
'rocketry': ['rocketry==2.4.0'],
'gutter': ['gutter==0.5.0'],
'mysql': ['pymysql==1.0.3',
'sqlalchemy==2.0.15',
'sqlacodegen==2.3.0',
'alembic==1.11.1'],
'schema': ['marshmallow==3.20.1'],
'security': ['cryptography'],
'dev': ['environs==9.5.0']
},