Skip to content

Commit 5d8511f

Browse files
frantumafrantuma
committed
enhanced logging
1 parent 9ce4c59 commit 5d8511f

File tree

4 files changed

+76
-9
lines changed

4 files changed

+76
-9
lines changed

‎modules/swagger-codegen/src/main/java/io/swagger/codegen/v3/config/CodegenConfigurator.java‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -437,7 +437,7 @@ public String loadSpecContent(String location, List<AuthorizationValue> auths) t
437437
data = ClasspathHelper.loadFileFromClasspath(location);
438438
}
439439
}
440-
LOGGER.debug("Loaded raw data: {}", data);
440+
LOGGER.trace("Loaded raw data: {}", data);
441441
return data;
442442
}
443443

@@ -470,6 +470,7 @@ public ClientOptInput toClientOptInput() {
470470
input.opts(new ClientOpts())
471471
.openAPI(openAPI);
472472

473+
LOGGER.debug("getClientOptInput - parsed inputSpec");
473474
} else {
474475
String specContent = null;
475476
try {
@@ -492,7 +493,7 @@ public ClientOptInput toClientOptInput() {
492493
options.setFlatten(true);
493494
SwaggerParseResult result = new OpenAPIParser().readLocation(inputSpecURL, authorizationValues, options);
494495
OpenAPI openAPI = result.getOpenAPI();
495-
496+
LOGGER.debug("getClientOptInput - parsed inputSpecURL " + inputSpecURL);
496497
input.opts(new ClientOpts())
497498
.openAPI(openAPI);
498499
}

‎modules/swagger-codegen/src/main/java/io/swagger/codegen/v3/service/GeneratorUtil.java‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ public class GeneratorUtil {
2626
protected static final Logger LOGGER = LoggerFactory.getLogger(GeneratorUtil.class);
2727

2828
public static io.swagger.codegen.ClientOptInput getClientOptInputV2(GenerationRequest generationRequest) {
29+
LOGGER.debug("getClientOptInputV2 - start");
2930
final Options options = generationRequest.getOptions();
3031
String inputSpec = null;
3132
if (generationRequest.getSpec() == null) {
@@ -38,7 +39,7 @@ public static io.swagger.codegen.ClientOptInput getClientOptInputV2(GenerationRe
3839
String inputSpecURL = generationRequest.getSpecURL();
3940
String lang = generationRequest.getLang();
4041
validateSpec(lang, inputSpec, inputSpecURL);
41-
42+
LOGGER.debug("getClientOptInputV2 - spec validated");
4243
final List<io.swagger.models.auth.AuthorizationValue> authorizationValues = io.swagger.codegen.auth.AuthParser.parse(generationRequest.getOptions().getAuth());
4344
if (generationRequest.getOptions().getAuthorizationValue() != null) {
4445
io.swagger.models.auth.AuthorizationValue authorizationValue = new io.swagger.models.auth.AuthorizationValue()
@@ -47,7 +48,7 @@ public static io.swagger.codegen.ClientOptInput getClientOptInputV2(GenerationRe
4748
.type(generationRequest.getOptions().getAuthorizationValue().getType());
4849
authorizationValues.add(authorizationValue);
4950
}
50-
51+
LOGGER.debug("getClientOptInputV2 - processed auth");
5152

5253
Swagger swagger;
5354
if (StringUtils.isBlank(inputSpec)) {
@@ -62,6 +63,7 @@ public static io.swagger.codegen.ClientOptInput getClientOptInputV2(GenerationRe
6263
} else {
6364
throw new BadRequestException("No swagger specification was supplied");
6465
}
66+
LOGGER.debug("getClientOptInputV2 - parsed inputSpecURL " + inputSpecURL);
6567
} else {
6668
try {
6769
JsonNode node = io.swagger.util.Json.mapper().readTree(inputSpec);
@@ -74,6 +76,7 @@ public static io.swagger.codegen.ClientOptInput getClientOptInputV2(GenerationRe
7476
LOGGER.error("Exception parsing input spec", e);
7577
throw new BadRequestException("The swagger specification supplied was not valid");
7678
}
79+
LOGGER.debug("getClientOptInputV2 - parsed inputSpec");
7780
}
7881
if (swagger == null) {
7982
throw new BadRequestException("The swagger specification supplied was not valid");
@@ -160,6 +163,7 @@ public static io.swagger.codegen.ClientOptInput getClientOptInputV2(GenerationRe
160163
codegenConfig.additionalProperties().put("swagger", swagger);
161164

162165
clientOptInput.setConfig(codegenConfig);
166+
LOGGER.debug("getClientOptInputV2 - end");
163167
return clientOptInput;
164168
}
165169

@@ -172,6 +176,7 @@ public static void validateSpec(String lang, String inputSpec, String inputSpecU
172176

173177
}
174178
public static ClientOptInput getClientOptInput(GenerationRequest generationRequest) {
179+
LOGGER.debug("getClientOptInput - start");
175180
final Options options = generationRequest.getOptions();
176181
String inputSpec = null;
177182
if (generationRequest.getSpec() == null) {
@@ -184,7 +189,7 @@ public static ClientOptInput getClientOptInput(GenerationRequest generationReque
184189
String inputSpecURL = generationRequest.getSpecURL();
185190
String lang = generationRequest.getLang();
186191
validateSpec(lang, inputSpec, inputSpecURL);
187-
192+
LOGGER.debug("getClientOptInput - validated");
188193
CodegenConfigurator configurator = new CodegenConfigurator();
189194

190195
configurator.setOutputDir(generationRequest.getOptions().getOutputDir());
@@ -278,7 +283,7 @@ public static ClientOptInput getClientOptInput(GenerationRequest generationReque
278283
configurator.addAdditionalReservedWordMapping(entry.getKey(), entry.getValue());
279284
}
280285
}
281-
286+
LOGGER.debug("getClientOptInput - end");
282287
return configurator.toClientOptInput();
283288
}
284289
}

‎modules/swagger-generator/src/main/java/io/swagger/v3/generator/online/GeneratorController.java‎

Lines changed: 58 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,7 @@ public ResponseContext listOptions(RequestContext requestContext, String languag
322322

323323
public ResponseContext generateFromURL(RequestContext context, String codegenOptionsURL) {
324324
final String content;
325-
325+
LOGGER.debug("generateFromURL start - " + codegenOptionsURL);
326326
try {
327327
content = RemoteUrl.urlToString(codegenOptionsURL, null);
328328
} catch (Exception e) {
@@ -359,11 +359,64 @@ public ResponseContext generateFromURL(RequestContext context, String codegenOpt
359359
}
360360
}
361361

362-
return generate(context, generationRequest);
362+
ResponseContext responseContext = generate(context, generationRequest);
363+
LOGGER.debug("generateFromURL end - " + codegenOptionsURL);
364+
return responseContext;
365+
366+
}
363367

368+
private String requestLog(GenerationRequest generationRequest) {
369+
final int maxLength = 41;
370+
StringBuffer requestLog = new StringBuffer();
371+
requestLog.append("lang: ");
372+
requestLog.append(generationRequest.getLang());
373+
requestLog.append(", ");
374+
requestLog.append("version: ");
375+
requestLog.append(generationRequest.getCodegenVersion().name());
376+
requestLog.append(", ");
377+
requestLog.append("specURL: ");
378+
requestLog.append(generationRequest.getSpecURL());
379+
requestLog.append(", ");
380+
if (generationRequest.getSpec() != null) {
381+
String spec = null;
382+
if (generationRequest.getSpec() instanceof String && StringUtils.isNotBlank((String) generationRequest.getSpec())) {
383+
if (((String) generationRequest.getSpec()).length() > maxLength) {
384+
spec = ((String) generationRequest.getSpec()).substring(0, 40);
385+
} else {
386+
spec = ((String) generationRequest.getSpec());
387+
}
388+
requestLog.append("spec: ");
389+
requestLog.append(spec);
390+
requestLog.append(", ");
391+
} else {
392+
try {
393+
spec = Json.pretty(generationRequest.getSpec());
394+
if (spec.length() > maxLength) {
395+
spec = spec.substring(0, 40);
396+
}
397+
requestLog.append("spec: ");
398+
requestLog.append(spec);
399+
requestLog.append(", ");
400+
} catch (Exception e) {
401+
requestLog.append("spec: ");
402+
requestLog.append(spec);
403+
requestLog.append(", ");
404+
}
405+
}
406+
}
407+
if (generationRequest.getOptions() != null) {
408+
if (StringUtils.isNotBlank(generationRequest.getOptions().getLibrary())) {
409+
requestLog.append("lib: ");
410+
requestLog.append(generationRequest.getOptions().getLibrary());
411+
}
412+
}
413+
return requestLog.toString();
364414
}
365415

366416
public ResponseContext generate(RequestContext context, GenerationRequest generationRequest) {
417+
418+
String requestLog = requestLog(generationRequest);
419+
LOGGER.debug("generate start - " + requestLog);
367420
File outputRootFolder = getTmpFolder();
368421
String destPath = null;
369422

@@ -406,7 +459,9 @@ public ResponseContext generate(RequestContext context, GenerationRequest genera
406459

407460
LOGGER.info("file zip file: " + outputFile.getAbsolutePath());
408461

409-
return generate(generationRequest, outputRootFolder, outputContentFolder, outputFile);
462+
ResponseContext responseContext = generate(generationRequest, outputRootFolder, outputContentFolder, outputFile);
463+
LOGGER.debug("generate end - " + requestLog);
464+
return responseContext;
410465

411466
}
412467

‎modules/swagger-generator/src/main/resources/logback.xml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@
88
<logger name="io.swagger" level="ERROR"/>
99
<logger name="org.eclipse.jetty.server" level="INFO"/>
1010
<logger name="io.swagger.v3.generator.online" level="DEBUG"/>
11+
<!--
12+
<logger name="io.swagger.codegen.v3.service" level="DEBUG"/>
13+
<logger name="io.swagger.codegen.v3.config" level="DEBUG"/>
14+
<logger name="io.swagger.codegen.v3.generators.DefaultCodegenConfig" level="TRACE"/>
15+
-->
16+
1117
<root level="WARN">
1218
<appender-ref ref="STDOUT"/>
1319
</root>

0 commit comments

Comments
 (0)