readme refactoring

Author: ozgurkara

README.md

@@ -7,8 +7,6 @@ This project is an example that how to implement FastAPI and the pydiator-core.
 `uvicorn main:app --reload`
 or `docker-compose up`
 
-swagger http://0.0.0.0:8000
-
 # How to run Tests
 `coverage run --source app/ -m pytest`
 
@@ -31,8 +29,8 @@ This architecture;
 
 There are ready implementations;
 * Redis cache
-* Swagger 
-* Opentracing via Jaeger
+* Swagger (http://0.0.0.0:8080)
+* Opentracing via Jaeger (http://0.0.0.0:16686/)
 
 
 # How to add the new use case? 
@@ -75,15 +73,15 @@ If the cache already exists, the cache pipeline returns with cache data so, the
 
    ```python
     class GetTodoAllRequest(BaseModel, BaseRequest, BaseCacheable):
-        # uses for cache key.
+        # cache key.
         def get_cache_key(self) -> str:
             return type(self).__name__ # it is cache key
 
         # cache duration value as second
         def get_cache_duration(self) -> int: 
             return 600
 
-        # pipeline decides the cache location via this
+        # cache location type
         def get_cache_type(self) -> CacheType:
             return CacheType.DISTRIBUTED
    ```
@@ -97,6 +95,26 @@ Requirements;
 2- Must be activated the below environment variables on the config for using the cache;
 
     DISTRIBUTED_CACHE_IS_ENABLED=True
-    
     CACHE_PIPELINE_IS_ENABLED=True
 
+# Tracing via Jaeger
+Requirements;
+
+1- Must have a jaeger server and should be set the below environment variables
+    
+    JAEGER_HOST = 'jaeger ip'
+    JAEGER_PORT = 'jaeger port'
+
+2- Must be activated the below environment variables on the config for using the jaeger;
+    
+    TRACER_IS_ENABLED=True
+
+![pydiator](https://raw.githubusercontent.com/ozgurkara/pydiator-core/master/assets/jaeger_is_not_enabled.png)
+
+3- If want to trace the handlers, should be activated the below environment variables on the config for using the jaeger. Otherwise, can just see the endpoint trace details.   
+
+    CACHE_PIPELINE_IS_ENABLED=True 
+
+![pydiator](https://raw.githubusercontent.com/ozgurkara/pydiator-core/master/assets/jaeger.png)
+
+

app/resources/todo/todo_resource.py

@@ -22,7 +22,7 @@
                 },
             })
 async def get_todo_all():
-    return await pydiator.send(GetTodoAllRequest())
+    return await pydiator.send(req=GetTodoAllRequest())
 
 
 @router.get("/{id}",
@@ -41,7 +41,7 @@ async def get_todo_all():
                 },
             })
 async def get_todo_by_id(id: int):
-    return await pydiator.send(GetTodoByIdRequest(id=id))
+    return await pydiator.send(req=GetTodoByIdRequest(id=id))
 
 
 @router.post("",
@@ -60,7 +60,7 @@ async def get_todo_by_id(id: int):
                  },
              })
 async def add_todo(req: AddTodoRequest):
-    return await pydiator.send(req)
+    return await pydiator.send(req=req)
 
 
 @router.put("/{id}",
@@ -79,7 +79,7 @@ async def add_todo(req: AddTodoRequest):
             })
 async def update_todo(id: int, req: UpdateTodoRequest):
     req.CustomFields.id = id
-    return await pydiator.send(req)
+    return await pydiator.send(req=req)
 
 
 @router.delete("/{id}",
@@ -97,4 +97,4 @@ async def update_todo(id: int, req: UpdateTodoRequest):
                    },
                })
 async def delete_todo(id: int):
-    return await pydiator.send(DeleteTodoByIdRequest(id=id))
+    return await pydiator.send(req=DeleteTodoByIdRequest(id=id))

app/utils/config.py

@@ -10,7 +10,7 @@
 REDIS_DB = config('REDIS_DB', int, 0)
 REDIS_KEY_PREFIX = config('REDIS_KEY_PREFIX', str, 'fastapi_pydiator:')
 
-DISTRIBUTED_CACHE_IS_ENABLED = config("DISTRIBUTED_CACHE_IS_ENABLED", bool, False)
+DISTRIBUTED_CACHE_IS_ENABLED = config("DISTRIBUTED_CACHE_IS_ENABLED", bool, True)
 CACHE_PIPELINE_IS_ENABLED = config("CACHE_PIPELINE_IS_ENABLED", bool, True)
 LOG_PIPELINE_IS_ENABLED = config("LOG_PIPELINE_IS_ENABLED", bool, True)
 TRACER_PIPELINE_IS_ENABLED = config("TRACER_PIPELINE_IS_ENABLED", bool, True)

app/utils/pydiator/pipelines/tracer_pipeline.py

@@ -21,5 +21,5 @@ async def handle(self, req: BaseRequest) -> object:
 
         with tracer.start_active_span(req.get_class_name(), child_of=current_span, tags=span_tags,
                                       finish_on_close=True):
-            response = await self.next().handle(req)
+            response = await self.next().handle(req=req)
             return response

docs/assets/jaeger.png

@@ -1,7 +1,7 @@
 uvicorn==0.13.3
 fastapi==0.63.0
 fastapi-contrib==0.2.9
-pydiator-core==1.0.6
+pydiator-core==1.0.7
 pydantic==1.7.3
 redis==3.5.3
 
@@ -13,7 +13,7 @@ pytest-env==0.6.2
 python-dotenv==0.15.0
 
 # tracing
-jaeger-client==4.3.0
+jaeger-client==4.4.0
 opentracing==2.4.0
 opentracing-instrumentation==3.3.1
 tornado==5.1.1