New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: generate readme from synth.py #96
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| custom_content: | | ||
| ### Usage | ||
| Add the appender to your [Logback configuration](https://logback.qos.ch/manual/configuration.html) `logback.xml`. | ||
| See [Logback filters](https://logback.qos.ch/manual/filters.html#thresholdFilter) for information on filtering log output and | ||
| [encoders](https://logback.qos.ch/manual/encoders.html) for information on formatting. | ||
|
|
||
|
|
||
| ```xml | ||
| <configuration> | ||
| <appender name="CLOUD" class="com.google.cloud.logging.logback.LoggingAppender"> | ||
| <!-- Optional : filter logs at or above a level --> | ||
| <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> | ||
| <level>INFO</level> | ||
| </filter> | ||
| <log>application.log</log> <!-- Optional : default java.log --> | ||
| <!-- Optional : will use the default credentials of the environment if this property is not set --> | ||
| <credentialsFile>/path/to/credentials.json</credentialsFile> | ||
| <enhancer>com.example.enhancers.TestLoggingEnhancer</enhancer> <!-- Optional --> | ||
| <enhancer>com.example.enhancers.AnotherEnhancer</enhancer> <!-- Optional --> | ||
| <flushLevel>WARN</flushLevel> <!-- Optional : default ERROR --> | ||
| </appender> | ||
|
|
||
| <root level="info"> | ||
| <appender-ref ref="CLOUD" /> | ||
| </root> | ||
| </configuration> | ||
| ``` | ||
|
|
||
| In your code : | ||
|
|
||
| ```java | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| public class TestLogger { | ||
| private final Logger logger = LoggerFactory.getLogger(TestLogger.class); | ||
|
|
||
| public void log(String name) { | ||
| logger.info("This is a test"); | ||
| } | ||
|
|
||
| public static void main(String[] args) { | ||
| TestLogger testLogger = new TestLogger(); | ||
| testLogger.log("test"); | ||
| } | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,6 +18,4 @@ | |
|
|
||
| AUTOSYNTH_MULTIPLE_COMMITS = True | ||
|
|
||
| java.common_templates(excludes=[ | ||
| 'README.md', | ||
| ]) | ||
| java.common_templates() | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove "Google" - it's mentioned twice