Permalink
Browse files

Merge pull request #28 from oyiptong/master

Better description of the plugin config subsection in the dictionary configuration section
  • Loading branch information...
2 parents c2e7239 + 0d3847a commit e1374c3692659cbf86b57f65ccea2d150f642266 @rafrombrc rafrombrc committed Jun 21, 2012
Showing with 13 additions and 9 deletions.
  1. +1 −1 docs/conf.py
  2. +11 −7 docs/config.rst
  3. +1 −1 metlog/client.py
View
@@ -50,7 +50,7 @@
# built documents.
#
# The short X.Y version.
-version = '0.8.6'
+version = '0.9.1'
# The full version, including alpha/beta/rc tags.
release = version
View
@@ -169,27 +169,31 @@ be converted to the following dictionary::
'sender': {'class': 'metlog.senders.zmq.ZmqPubSender',
'bindstrs': 'tcp://127.0.0.1:5565',
'queue_length': 5000,
- },
- 'global': {'disabled_decorators': ['incr_count'],
- },
+ },
+ 'global': {'disabled_decorators': ['incr_count']},
'filters': [('metlog.filters.severity_max',
{'severity': 4},
),
('metlog.filters.type_whitelist',
{'types': ['timer', 'oldstyle']},
),
- ],
+ ],
}
To manually load a Metlog client with plugins, the `client_from_dict_config`
-function allows you to pass in a plugin_parm argument. The configuration
-specified in the "plugins" section above would be converted into the following
-dictionary ::
+function allows you to pass in a list of plugin configurations using the
+`plugins` dict key, used in the same fashion as `filters` in the example
+directly above.
+
+The configuration specified in the "plugins" section above would be converted
+into the following dictionary, where the key will be the name of the method
+bound to the client::
{'dummy': ('metlog.tests.plugin:config_plugin',
{'port': 8080,
'host': 'localhost'
},
+ )
}
View
@@ -116,7 +116,7 @@ class MetlogClient(object):
Client class encapsulating metlog API, and providing storage for default
values for various metlog call settings.
"""
- env_version = '0.8'
+ env_version = '0.9'
def __init__(self, sender, logger, severity=6,
disabled_timers=None, filters=None):

0 comments on commit e1374c3

Please sign in to comment.